Documentation
¶
Overview ¶
Package fs provided support for local file system.
Code generated by go generate via cmd/definitions; DO NOT EDIT.
Index ¶
- Constants
- func NewStorager(pairs ...typ.Pair) (typ.Storager, error)
- func WithDefaultStoragePairs(v DefaultStoragePairs) Pair
- func WithStorageFeatures(v StorageFeatures) Pair
- type DefaultStoragePairs
- type ObjectSystemMetadata
- type Storage
- func (s *Storage) CommitAppend(o *Object, pairs ...Pair) (err error)
- func (s *Storage) CommitAppendWithContext(ctx context.Context, o *Object, pairs ...Pair) (err error)
- func (s *Storage) Copy(src string, dst string, pairs ...Pair) (err error)
- func (s *Storage) CopyWithContext(ctx context.Context, src string, dst string, pairs ...Pair) (err error)
- func (s *Storage) Create(path string, pairs ...Pair) (o *Object)
- func (s *Storage) CreateAppend(path string, pairs ...Pair) (o *Object, err error)
- func (s *Storage) CreateAppendWithContext(ctx context.Context, path string, pairs ...Pair) (o *Object, err error)
- func (s *Storage) CreateDir(path string, pairs ...Pair) (o *Object, err error)
- func (s *Storage) CreateDirWithContext(ctx context.Context, path string, pairs ...Pair) (o *Object, err error)
- func (s *Storage) CreateLink(path string, target string, pairs ...Pair) (o *Object, err error)
- func (s *Storage) CreateLinkWithContext(ctx context.Context, path string, target string, pairs ...Pair) (o *Object, err error)
- func (s *Storage) Delete(path string, pairs ...Pair) (err error)
- func (s *Storage) DeleteWithContext(ctx context.Context, path string, pairs ...Pair) (err error)
- func (s *Storage) Fetch(path string, url string, pairs ...Pair) (err error)
- func (s *Storage) FetchWithContext(ctx context.Context, path string, url string, pairs ...Pair) (err error)
- func (s *Storage) List(path string, pairs ...Pair) (oi *ObjectIterator, err error)
- func (s *Storage) ListWithContext(ctx context.Context, path string, pairs ...Pair) (oi *ObjectIterator, err error)
- func (s *Storage) Metadata(pairs ...Pair) (meta *StorageMeta)
- func (s *Storage) Move(src string, dst string, pairs ...Pair) (err error)
- func (s *Storage) MoveWithContext(ctx context.Context, src string, dst string, pairs ...Pair) (err error)
- func (s *Storage) Read(path string, w io.Writer, pairs ...Pair) (n int64, err error)
- func (s *Storage) ReadWithContext(ctx context.Context, path string, w io.Writer, pairs ...Pair) (n int64, err error)
- func (s *Storage) Stat(path string, pairs ...Pair) (o *Object, err error)
- func (s *Storage) StatWithContext(ctx context.Context, path string, pairs ...Pair) (o *Object, err error)
- func (s *Storage) String() string
- func (s *Storage) Write(path string, r io.Reader, size int64, pairs ...Pair) (n int64, err error)
- func (s *Storage) WriteAppend(o *Object, r io.Reader, size int64, pairs ...Pair) (n int64, err error)
- func (s *Storage) WriteAppendWithContext(ctx context.Context, o *Object, r io.Reader, size int64, pairs ...Pair) (n int64, err error)
- func (s *Storage) WriteWithContext(ctx context.Context, path string, r io.Reader, size int64, pairs ...Pair) (n int64, err error)
- type StorageFeatures
- type StorageSystemMetadata
Constants ¶
const ( // The file type is unknown. DirentTypeUnknown = 0 // This is a named pipe (FIFO). DirentTypeFIFO = 1 // This is a character device. DirentTypeCharDevice = 2 // This is a directory. DirentTypeDirectory = 4 // This is a block device. DirentTypeBlockDevice = 6 // This is a regular file. DirentTypeRegular = 8 // This is a symbolic link. DirentTypeLink = 10 // This is a UNIX domain socket. DirentTypeSocket = 12 // WhiteOut from BSD, don't know what's it mean. DirentTypeWhiteOut = 14 )
Available value for Dirent Type
Copied from linux kernel <dirent.h> #define DT_UNKNOWN 0 #define DT_FIFO 1 #define DT_CHR 2 #define DT_DIR 4 #define DT_BLK 6 #define DT_REG 8 #define DT_LNK 10 #define DT_SOCK 12 #define DT_WHT 14
const ( Stdin = "/dev/stdin" Stdout = "/dev/stdout" Stderr = "/dev/stderr" )
Std{in/out/err} support
const Type = "fs"
Type is the type for fs
Variables ¶
This section is empty.
Functions ¶
func NewStorager ¶
NewStorager will create Storager only.
func WithDefaultStoragePairs ¶
func WithDefaultStoragePairs(v DefaultStoragePairs) Pair
WithDefaultStoragePairs will apply default_storage_pairs value to Options.
set default pairs for storager actions
func WithStorageFeatures ¶
func WithStorageFeatures(v StorageFeatures) Pair
WithStorageFeatures will apply storage_features value to Options.
set storage features
Types ¶
type DefaultStoragePairs ¶
type DefaultStoragePairs struct { CommitAppend []Pair Copy []Pair Create []Pair CreateAppend []Pair CreateDir []Pair CreateLink []Pair Delete []Pair Fetch []Pair List []Pair Metadata []Pair Move []Pair Read []Pair Stat []Pair Write []Pair WriteAppend []Pair }
DefaultStoragePairs is default pairs for specific action
type ObjectSystemMetadata ¶
type ObjectSystemMetadata struct { }
ObjectSystemMetadata stores system metadata for object.
func GetObjectSystemMetadata ¶
func GetObjectSystemMetadata(o *Object) ObjectSystemMetadata
GetObjectSystemMetadata will get ObjectSystemMetadata from Object.
- This function should not be called by service implementer. - The returning ObjectServiceMetadata is read only and should not be modified.
type Storage ¶
type Storage struct { typ.UnimplementedStorager typ.UnimplementedCopier typ.UnimplementedMover typ.UnimplementedFetcher typ.UnimplementedAppender typ.UnimplementedDirer typ.UnimplementedLinker // contains filtered or unexported fields }
Storage is the fs client.
func (*Storage) CommitAppend ¶
func (*Storage) CommitAppendWithContext ¶
func (*Storage) CopyWithContext ¶
func (*Storage) CreateAppend ¶
func (*Storage) CreateAppendWithContext ¶
func (*Storage) CreateDirWithContext ¶
func (*Storage) CreateLink ¶
func (*Storage) CreateLinkWithContext ¶
func (*Storage) DeleteWithContext ¶
func (*Storage) FetchWithContext ¶
func (*Storage) ListWithContext ¶
func (*Storage) MoveWithContext ¶
func (*Storage) ReadWithContext ¶
func (*Storage) StatWithContext ¶
func (*Storage) WriteAppend ¶
func (*Storage) WriteAppendWithContext ¶
type StorageFeatures ¶
type StorageFeatures struct { }
type StorageSystemMetadata ¶
type StorageSystemMetadata struct { }
StorageSystemMetadata stores system metadata for object.
func GetStorageSystemMetadata ¶
func GetStorageSystemMetadata(s *StorageMeta) StorageSystemMetadata
GetStorageSystemMetadata will get StorageSystemMetadata from Storage.
- This function should not be called by service implementer. - The returning StorageServiceMetadata is read only and should not be modified.