storage

type BucketName string

type Client interface {
	// PutObject 上传单个对象
	PutObject(input ObjectInput, opts ...func(o *PutOptions)) error
	// PutFolder 上传本地文件夹，存储路径为 'prefix/root/xxx'
	PutFolder(bucket string, prefix string, root string, opts ...func(o *PutOptions)) error

	// GetObject 根据对象路径，获取单个对象
	GetObject(bucket string, key string, opts ...func(o *GetOptions)) (*ObjectOutputHook, error)
	// GetObjectsWithIterator 根据对象前缀，获取多个对象
	GetObjectsWithIterator(bucket string, prefix string, iterator func(keys []*string) error, opts ...func(o *ListOptions)) error

	// DelObject 删除单个对象
	DelObject(bucket string, key string, opts ...func(o *DelOptions)) error
	// DelObjectsWithPrefix 根据对象前缀，删除多个对象
	DelObjectsWithPrefix(bucket string, prefix string, opts ...func(o *DelOptions)) error

	// Copy 对象拷贝
	Copy(src Position, dst Position, opts ...func(o *CopyOptions)) error

	// IsExist 查询对象是否存在
	IsExist(bucket string, key string, opts ...func(o *GetOptions)) (bool, error)

	// Presign 获取对象 HTTP 访问路径
	Presign(bucket string, key string, opts ...func(o *PresignOptions)) (string, error)

	// Downloads 根据前缀，批量下载对象至本地存储，本地存储路径为 'root/prefix/xxx'
	Downloads(bucket string, prefix string, root string, opts ...func(o *ListOptions)) error
}

type CopyOptions struct {
	Context context.Context
	// increases the number of callers skipped by caller annotation
	CallerSkip int
}

type DelOptions struct {
	Context context.Context
	// object version id
	VersionID string
	// increases the number of callers skipped by caller annotation
	CallerSkip int
}

type GetOptions struct {
	Context context.Context
	// object version
	VersionID string
	// increases the number of callers skipped by caller annotation
	CallerSkip int
}

type KeyName string

type KeyPrefixName string

type ListOptions struct {
	Context context.Context
	MaxKeys int
	// ignore '/' delimiter
	Recursive bool
	// increases the number of callers skipped by caller annotation
	CallerSkip int
}

type ObjectInput interface {
	Bucket() string
	Key() string
	ContentType() string
	Close() error
	Error() error
	Body() io.ReadSeeker
}

type ObjectOutput interface {
	Bucket() string
	Key() string
	ContentType() content.Type
	Decode(vPointer interface{}) error
	Body() io.ReadCloser
	Close() error
}

type ObjectOutputHook struct {
	// Fetch get object with io.ReadCloser
	Fetch func(hook func(output ObjectOutput) error) error
	// Write write object to io.WriterAt
	Write func(w io.WriterAt) error
}

type Options struct {
	// Context context
	Context context.Context
	// Timeout 连接超时时间
	Timeout time.Duration
	// Region region
	Region string
	// SSL use ssl
	UseSSL bool
}

type Position interface {
	Bucket() string
	Key() string
	IsPrefix() bool
}

type PresignOptions struct {
	Context context.Context
	// object version id
	VersionID string
	// expires time (s)
	Expires time.Duration
	// increases the number of callers skipped by caller annotation
	CallerSkip int
}

type PutOptions struct {
	Context context.Context
	// increases the number of callers skipped by caller annotation
	CallerSkip int
}

type Validator interface {
	Error() error
}

type ValidatorFunc func() error