storage

Documentation

Index

• Constants
• Variables
• type Blob
• type Descriptor
• type Key
• type StorageDriver
• type StorageDriverParameters

Constants

const (
	AppStorageDriverContextVar = "app.storage"
)

Variables

var (
	// ErrBlobExists returned when blob already exists
	ErrBlobExists = errors.New("blob exists")

	// ErrBlobUnknown when blob is not found.
	ErrBlobUnknown = errors.New("unknown blob")
)

Types

type Blob

type Blob []byte

type Descriptor

type Descriptor struct {
	// Digest uniquely identifies the content. A byte stream can be verified
	// against against this digest.
	Digest digest.Digest `json:"digest,omitempty"`

	// Size in bytes of content.
	Size int64 `json:"size,omitempty"`
}

type Key

type Key string

type StorageDriver

type StorageDriver interface {
	Name() string
	Has(digest.Digest) (bool, error)
	Stat(digest.Digest) (Descriptor, error)
	Read(digest.Digest) (Blob, error)
	Reader(digest.Digest) (io.ReadCloser, error)
	Write(Blob) (digest.Digest, error)
	Delete(digest.Digest) error
	Iterate(handler func(Key, Blob) (bool, error)) error
	Close() error
}

type StorageDriverParameters

type StorageDriverParameters map[string]string