forked from bufbuild/buf
/
storageos.go
65 lines (57 loc) · 2.34 KB
/
storageos.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
// Copyright 2020-2024 Buf Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package storageos implements an os-backed storage Bucket.
package storageos
import (
"github.com/alis-exchange/buf/private/pkg/storage"
)
// Provider provides new ReadWriteBuckets.
type Provider interface {
// NewReadWriteBucket returns a new OS bucket.
//
// Only regular files are handled, that is Exists should only be called
// for regular files, Get and Put only work for regular files, Put
// automatically calls Mkdir, and Walk only calls f on regular files.
//
// The root path is expected to be normalized, however the root path
// can be absolute or jump context.
//
// Not thread-safe.
NewReadWriteBucket(rootPath string, options ...ReadWriteBucketOption) (storage.ReadWriteBucket, error)
}
// NewProvider returns a new Provider.
func NewProvider(options ...ProviderOption) Provider {
return newProvider(options...)
}
// ProviderOption is an option for a new Provider.
type ProviderOption func(*provider)
// ReadWriteBucketOption is an option for a new ReadWriteBucket.
type ReadWriteBucketOption func(*readWriteBucketOptions)
// ReadWriteBucketWithSymlinksIfSupported returns a ReadWriteBucketOption that results
// in symlink support being enabled for this bucket. If the Provider did not have symlink
// support, this is a no-op.
func ReadWriteBucketWithSymlinksIfSupported() ReadWriteBucketOption {
return func(readWriteBucketOptions *readWriteBucketOptions) {
readWriteBucketOptions.symlinksIfSupported = true
}
}
// ProviderWithSymlinks returns a ProviderOption that results in symlink support.
//
// Note that ReadWriteBucketWithSymlinksIfSupported still needs to be passed for a given
// ReadWriteBucket to have symlinks followed.
func ProviderWithSymlinks() ProviderOption {
return func(provider *provider) {
provider.symlinks = true
}
}