Documentation
¶
Overview ¶
Code generated by go generate via cmd/definitions; DO NOT EDIT.
Index ¶
- Constants
- func NewServicer(pairs ...typ.Pair) (typ.Servicer, error)
- func NewStorager(pairs ...typ.Pair) (typ.Storager, error)
- func WithDefaultServicePairs(v DefaultServicePairs) Pair
- func WithDefaultStorageClass(v string) Pair
- func WithDefaultStoragePairs(v DefaultStoragePairs) Pair
- func WithDisableURICleaning() Pair
- func WithEnableLoosePair() Pair
- func WithEnableVirtualDir() Pair
- func WithServiceFeatures(v ServiceFeatures) Pair
- func WithStorageClass(v string) Pair
- func WithStorageFeatures(v StorageFeatures) Pair
- func WithStringPair(v string) Pair
- type DefaultServicePairs
- type DefaultStoragePairs
- type ObjectSystemMetadata
- type Service
- func (s *Service) Create(name string, pairs ...Pair) (store Storager, err error)
- func (s *Service) CreateWithContext(ctx context.Context, name string, pairs ...Pair) (store Storager, err error)
- func (s *Service) Delete(name string, pairs ...Pair) (err error)
- func (s *Service) DeleteWithContext(ctx context.Context, name string, pairs ...Pair) (err error)
- func (s *Service) Get(name string, pairs ...Pair) (store Storager, err error)
- func (s *Service) GetWithContext(ctx context.Context, name string, pairs ...Pair) (store Storager, err error)
- func (s *Service) List(pairs ...Pair) (sti *StoragerIterator, err error)
- func (s *Service) ListWithContext(ctx context.Context, pairs ...Pair) (sti *StoragerIterator, err error)
- func (s *Service) String() string
- type ServiceFeatures
- 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) CompleteMultipart(o *Object, parts []*Part, pairs ...Pair) (err error)
- func (s *Storage) CompleteMultipartWithContext(ctx context.Context, o *Object, parts []*Part, 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) CreateMultipart(path string, pairs ...Pair) (o *Object, err error)
- func (s *Storage) CreateMultipartWithContext(ctx context.Context, path 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) ListMultipart(o *Object, pairs ...Pair) (pi *PartIterator, err error)
- func (s *Storage) ListMultipartWithContext(ctx context.Context, o *Object, pairs ...Pair) (pi *PartIterator, 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) Reach(path string, pairs ...Pair) (url string, err error)
- func (s *Storage) ReachWithContext(ctx context.Context, path string, pairs ...Pair) (url string, 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) WriteMultipart(o *Object, r io.Reader, size int64, index int, pairs ...Pair) (n int64, part *Part, err error)
- func (s *Storage) WriteMultipartWithContext(ctx context.Context, o *Object, r io.Reader, size int64, index int, ...) (n int64, part *Part, 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 Type = "tests"
Type is the type for tests
Variables ¶
This section is empty.
Functions ¶
func WithDefaultServicePairs ¶
func WithDefaultServicePairs(v DefaultServicePairs) Pair
WithDefaultServicePairs will apply default_service_pairs value to Options.
set default pairs for service actions
func WithDefaultStorageClass ¶ added in v4.5.0
func WithDefaultStorageClass(v string) Pair
WithDefaultStorageClass will apply default_storage_class value to Options.
func WithDefaultStoragePairs ¶
func WithDefaultStoragePairs(v DefaultStoragePairs) Pair
WithDefaultStoragePairs will apply default_storage_pairs value to Options.
set default pairs for storager actions
func WithDisableURICleaning ¶
func WithDisableURICleaning() Pair
WithDisableURICleaning will apply disable_uri_cleaning value to Options.
func WithEnableLoosePair ¶ added in v4.5.0
func WithEnableLoosePair() Pair
WithEnableLoosePair will apply enable_loose_pair value to Options.
loose_pair feature is designed for users who don't want strict pair checks.
If this feature is enabled, the service will not return an error for not support pairs.
This feature was introduced in GSP-109.
func WithEnableVirtualDir ¶ added in v4.5.0
func WithEnableVirtualDir() Pair
WithEnableVirtualDir will apply enable_virtual_dir value to Options.
virtual_dir feature is designed for a service that doesn't have native dir support but wants to provide simulated operations.
- If this feature is disabled (the default behavior), the service will behave like it doesn't have any dir support. - If this feature is enabled, the service will support simulated dir behavior in create_dir, create, list, delete, and so on.
This feature was introduced in GSP-109.
func WithServiceFeatures ¶
func WithServiceFeatures(v ServiceFeatures) Pair
WithServiceFeatures will apply service_features value to Options.
set service features
func WithStorageClass ¶
func WithStorageClass(v string) Pair
WithStorageClass will apply storage_class value to Options.
func WithStorageFeatures ¶
func WithStorageFeatures(v StorageFeatures) Pair
WithStorageFeatures will apply storage_features value to Options.
set storage features
func WithStringPair ¶
func WithStringPair(v string) Pair
WithStringPair will apply string_pair value to Options.
tests connection string
Types ¶
type DefaultServicePairs ¶
type DefaultServicePairs struct {
Create []Pair
Delete []Pair
Get []Pair
List []Pair
}
DefaultServicePairs is default pairs for specific action
type DefaultStoragePairs ¶
type DefaultStoragePairs struct {
CommitAppend []Pair
CompleteMultipart []Pair
Copy []Pair
Create []Pair
CreateAppend []Pair
CreateMultipart []Pair
Delete []Pair
Fetch []Pair
List []Pair
ListMultipart []Pair
Metadata []Pair
Move []Pair
Reach []Pair
Read []Pair
Stat []Pair
Write []Pair
WriteAppend []Pair
WriteMultipart []Pair
}
DefaultStoragePairs is default pairs for specific action
type ObjectSystemMetadata ¶
type ObjectSystemMetadata struct {
StorageClass string
}
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 Service ¶
type Service struct {
Pairs []Pair
UnimplementedServicer
// contains filtered or unexported fields
}
func (*Service) CreateWithContext ¶
func (*Service) DeleteWithContext ¶
func (*Service) GetWithContext ¶
func (*Service) ListWithContext ¶
type ServiceFeatures ¶
type ServiceFeatures struct {
}
type Storage ¶
type Storage struct {
Pairs []Pair
UnimplementedCopier
UnimplementedFetcher
UnimplementedMover
UnimplementedMultiparter
UnimplementedReacher
UnimplementedAppender
UnimplementedStorager
// contains filtered or unexported fields
}
func (*Storage) CommitAppend ¶
func (*Storage) CommitAppendWithContext ¶
func (*Storage) CompleteMultipart ¶
func (*Storage) CompleteMultipartWithContext ¶
func (*Storage) CopyWithContext ¶
func (*Storage) CreateAppend ¶
func (*Storage) CreateAppendWithContext ¶
func (*Storage) CreateMultipart ¶
func (*Storage) CreateMultipartWithContext ¶
func (*Storage) DeleteWithContext ¶
func (*Storage) FetchWithContext ¶
func (*Storage) ListMultipart ¶
func (*Storage) ListMultipartWithContext ¶
func (*Storage) ListWithContext ¶
func (*Storage) MoveWithContext ¶
func (*Storage) ReachWithContext ¶
func (*Storage) ReadWithContext ¶
func (*Storage) StatWithContext ¶
func (*Storage) WriteAppend ¶
func (*Storage) WriteAppendWithContext ¶
func (*Storage) WriteMultipart ¶
func (*Storage) WriteMultipartWithContext ¶
type StorageFeatures ¶
type StorageFeatures struct {
//
// If this feature is enabled, the service will not return an error for not support pairs.
//
// This feature was introduced in GSP-109.
LoosePair bool
// virtual_dir feature is designed for a service that doesn't have native dir support but wants to
// provide simulated operations.
//
// - If this feature is disabled (the default behavior), the service will behave like it doesn't have
// any dir support.
// - If this feature is enabled, the service will support simulated dir behavior in create_dir, create,
// list, delete, and so on.
//
// This feature was introduced in GSP-109.
VirtualDir bool
}
type StorageSystemMetadata ¶
type StorageSystemMetadata struct {
StorageClass string
}
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.