Documentation
¶
Index ¶
- func BlobAccess(path string, opts ...Option) (_ bpi.BlobAccess, rerr error)
- func BlobAccessForDirTree(path string, opts ...Option) (_ bpi.BlobAccess, rerr error)
- func BlobAccessProviderForDirTree(path string, opts ...Option) bpi.BlobAccessProvider
- func DataAccess(path string, opts ...Option) (bpi.DataAccess, error)
- func Provider(path string, opts ...Option) bpi.BlobAccessProvider
- type Option
- type Options
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BlobAccess ¶ added in v0.12.0
func BlobAccess(path string, opts ...Option) (_ bpi.BlobAccess, rerr error)
func BlobAccessForDirTree ¶
func BlobAccessForDirTree(path string, opts ...Option) (_ bpi.BlobAccess, rerr error)
BlobAccessForDirTree returns a BlobAccess for the given directory tree. Deprecated: use BlobAccess.
func BlobAccessProviderForDirTree ¶
func BlobAccessProviderForDirTree(path string, opts ...Option) bpi.BlobAccessProvider
BlobAccessProviderForDirTree returns a BlobAccessProvider for the given directory tree. Deprecated: use Provider.
func DataAccess ¶ added in v0.12.0
func DataAccess(path string, opts ...Option) (bpi.DataAccess, error)
Types ¶
type Option ¶
type Option = optionutils.Option[*Options]
func WithCompressWithGzip ¶
func WithExcludeFiles ¶
func WithFileSystem ¶
func WithFileSystem(fs vfs.FileSystem) Option
func WithFollowSymlinks ¶
func WithIncludeFiles ¶
func WithMimeType ¶
func WithPreserveDir ¶
type Options ¶
type Options struct {
// FileSystem defines the file system that contains the specified directory.
FileSystem vfs.FileSystem
MimeType string
// CompressWithGzip defines whether the specified directory should be compressed.
CompressWithGzip *bool `json:"compress,omitempty"`
// PreserveDir defines that the specified directory should be included in the blob.
PreserveDir *bool `json:"preserveDir,omitempty"`
// IncludeFiles is a list of shell file name patterns that describe the files that should be included.
// If nothing is defined, all files are included.
IncludeFiles []string `json:"includeFiles,omitempty"`
// ExcludeFiles is a list of shell file name patterns that describe the files that should be excluded from the resulting tar.
// Excluded files always overwrite included files.
ExcludeFiles []string `json:"excludeFiles,omitempty"`
// FollowSymlinks configures to follow and resolve symlinks when a directory is tarred.
// This options will include the content of the symlink directly in the tar.
// This option should be used with care.
FollowSymlinks *bool `json:"followSymlinks,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.