filestore

Documentation

Index

• Variables
• type Closer
• type Deleter
• type Getter
• type Lister
• type ObjectAttrs
• type Putter
• type Store

Variables

var (
	ErrNotFound = errors.New("not found")
)

Types

type Closer

type Closer interface {
	Close() error
}

type Deleter

type Deleter interface {
	// Delete deletes a file object at the given path.
	Delete(ctx context.Context, path string) error
}

type Getter

type Getter interface {
	// Get returns bytes content of file object at the given path.
	Get(ctx context.Context, path string) ([]byte, error)

	// GetReader returns a new Reader to read the contents of the object.
	// The caller must call Close on the returned Reader when done reading.
	GetReader(ctx context.Context, path string) (io.ReadCloser, error)
}

type Lister

type Lister interface {
	// List finds all objects in storage where its path starts with the given prefix
	// and returns objects' attributes (without content).
	List(ctx context.Context, prefix string) ([]ObjectAttrs, error)
}

type ObjectAttrs

type ObjectAttrs struct {
	Path      string
	Size      int64
	Etag      string
	UpdatedAt int64
}

type Putter

type Putter interface {
	// Put uploads a file object to store at the given path.
	Put(ctx context.Context, path string, content []byte) error
}

type Store

type Store interface {
	Getter
	Putter
	Deleter
	Lister
	Closer
}