bsw

README

bsw

Block storage wrapper (S3, Google drive, etc)

Documentation

Index

• Variables
• type BlockStorageWrapper
• type CompletedPart
• type Object
  • func NewObject(w BlockStorageWrapper, bucket, key string, opts ...Option) *Object
  • func (o *Object) Bucket() string
  • func (o *Object) Key() string
  • func (o *Object) Metadata() map[string]*string
  • func (o *Object) MultipartUploadURLs(timeout time.Duration) (urls []string, uploadID string, err error)
  • func (o *Object) Parts() int
  • func (o *Object) ReplaceMetadata(m map[string]*string) *Object
  • func (o *Object) SetMetadata(key, value string) *Object
  • func (o *Object) SetValidTill(t int64) *Object
  • func (o *Object) StillValid() bool
  • func (o *Object) UploadURL(timeout time.Duration) (string, error)
• type Option
  • func WithMetadata(m map[string]*string) Option
  • func WithMultiParts(parts int) Option
  • func WithValidTill(t int64) Option

Variables

var ErrWrongInvocation = errors.New("wrong invocation").Critical()

Types

type BlockStorageWrapper

type BlockStorageWrapper interface {
	Name() string
	PreSignPutObjectURL(o *Object, timeout time.Duration) (string, error)
	PreSignMultipartObjectURL(o *Object, timeout time.Duration) (urls []string, uploadID string, err error)
	CompleteMultipartUpload(o *Object, uploadID string, parts []CompletedPart) error
	PreSignGetObjectURL(o *Object, timeout time.Duration) (string, error)
}

type CompletedPart

type CompletedPart interface {
	ETagPtr() *string
	PartNumberPtr() *int64
}

type Object

type Object struct {
	// contains filtered or unexported fields
}

func NewObject

func NewObject(w BlockStorageWrapper, bucket, key string, opts ...Option) *Object

func (*Object) Bucket

func (o *Object) Bucket() string

func (*Object) Key

func (o *Object) Key() string

func (*Object) Metadata

func (o *Object) Metadata() map[string]*string

func (*Object) MultipartUploadURLs

func (o *Object) MultipartUploadURLs(timeout time.Duration) (urls []string, uploadID string, err error)

MultipartUploadURLs returns presigned URLs for PUT object request by parts. When all parts uploaded, call CompleteMultipartUpload to merge parts into a single file.

func (*Object) Parts

func (o *Object) Parts() int

func (*Object) ReplaceMetadata

func (o *Object) ReplaceMetadata(m map[string]*string) *Object

func (*Object) SetMetadata

func (o *Object) SetMetadata(key, value string) *Object

func (*Object) SetValidTill

func (o *Object) SetValidTill(t int64) *Object

func (*Object) StillValid

func (o *Object) StillValid() bool

func (*Object) UploadURL

func (o *Object) UploadURL(timeout time.Duration) (string, error)

UploadURL returns presigned URL for PUT object request.

type Option

type Option func(*Object)

func WithMetadata

func WithMetadata(m map[string]*string) Option

func WithMultiParts

func WithMultiParts(parts int) Option

func WithValidTill

func WithValidTill(t int64) Option