buckets

Documentation

Index

• type BucketStore
  • func (b *BucketStore) Delete(ctx context.Context, bucket string) (err error)
  • func (b *BucketStore) Get(ctx context.Context, bucket string) (meta Meta, err error)
  • func (b *BucketStore) GetObjectStore(ctx context.Context, bucket string) (objects.Store, error)
  • func (b *BucketStore) List(ctx context.Context, startAfter, endBefore string, limit int) (items []ListItem, more bool, err error)
  • func (b *BucketStore) Put(ctx context.Context, bucket string, pathCipher storj.Cipher) (meta Meta, err error)
• type ListItem
• type Meta
• type Store
  • func NewStore(stream streams.Store) Store

Types

type BucketStore

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

BucketStore contains objects store

func (*BucketStore) Delete

func (b *BucketStore) Delete(ctx context.Context, bucket string) (err error)

Delete calls objects store Delete

func (*BucketStore) Get

func (b *BucketStore) Get(ctx context.Context, bucket string) (meta Meta, err error)

Get calls objects store Get

func (*BucketStore) GetObjectStore

func (b *BucketStore) GetObjectStore(ctx context.Context, bucket string) (objects.Store, error)

GetObjectStore returns an implementation of objects.Store

func (*BucketStore) List

func (b *BucketStore) List(ctx context.Context, startAfter, endBefore string, limit int) (items []ListItem, more bool, err error)

List calls objects store List

func (*BucketStore) Put

func (b *BucketStore) Put(ctx context.Context, bucket string, pathCipher storj.Cipher) (meta Meta, err error)

Put calls objects store Put

type ListItem

type ListItem struct {
	Bucket string
	Meta   Meta
}

ListItem is a single item in a listing

type Meta

type Meta struct {
	Created            time.Time
	PathEncryptionType storj.Cipher
	SegmentsSize       int64
	RedundancyScheme   storj.RedundancyScheme
	EncryptionScheme   storj.EncryptionScheme
}

Meta is the bucket metadata struct

type Store

type Store interface {
	Get(ctx context.Context, bucket string) (meta Meta, err error)
	Put(ctx context.Context, bucket string, pathCipher storj.Cipher) (meta Meta, err error)
	Delete(ctx context.Context, bucket string) (err error)
	List(ctx context.Context, startAfter, endBefore string, limit int) (items []ListItem, more bool, err error)
	GetObjectStore(ctx context.Context, bucketName string) (store objects.Store, err error)
}

Store creates an interface for interacting with buckets

func NewStore

func NewStore(stream streams.Store) Store

NewStore instantiates BucketStore