store

Documentation

Index

• Variables
• func Extension(ct ContentType, ce ContentEncoding) string
• func FilePath(key string, headers *Headers) string
• type ContentEncoding
  • func ParseContentEncoding(compression string) (ContentEncoding, error)
  • func (ce ContentEncoding) FileExtension() string
  • func (ce ContentEncoding) FilePath(key string) string
  • func (ce ContentEncoding) String() string
• type ContentType
  • func ParseContentType(contentType string) (ContentType, error)
  • func (ct ContentType) FileExtension() string
  • func (ct ContentType) FilePath(key string) string
  • func (ct ContentType) String() string
• type Headers
  • func (h *Headers) GetContentEncoding() (ContentEncoding, error)
  • func (h *Headers) GetContentType() (string, error)
• type Store
  • func NewNoOpStore() Store
  • func WithLog(store Store) Store
  • func WithMetrics(store Store) Store
  • func WithTags(store Store) Store

Variables

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

Functions

func Extension

func Extension(ct ContentType, ce ContentEncoding) string

func FilePath

func FilePath(key string, headers *Headers) string

Types

type ContentEncoding

type ContentEncoding int

const (
	ContentEncodingPlain ContentEncoding = iota
	ContentEncodingGzip
	ContentEncodingZlib
	ContentEncodingFlate
)

func ParseContentEncoding

func ParseContentEncoding(compression string) (ContentEncoding, error)

func (ContentEncoding) FileExtension

func (ce ContentEncoding) FileExtension() string

func (ContentEncoding) FilePath

func (ce ContentEncoding) FilePath(key string) string

func (ContentEncoding) String

func (ce ContentEncoding) String() string

type ContentType

type ContentType int

const (
	ContentTypeUnknown ContentType = iota
	ContentTypeText
	ContentTypeJSON
	ContentTypeProtobuf
)

func ParseContentType

func ParseContentType(contentType string) (ContentType, error)

func (ContentType) FileExtension

func (ct ContentType) FileExtension() string

func (ContentType) FilePath

func (ct ContentType) FilePath(key string) string

func (ContentType) String

func (ct ContentType) String() string

type Headers

type Headers struct {
	// ContentType is the type of the object
	ContentType ContentType

	// ContentEncoding is the compression algorithm used to store the object.
	ContentEncoding ContentEncoding

	// KeyValue is a map of key-value pairs to store/load with the object.
	KeyValue map[string]string
}

Headers are optional metadata about an object to store/load

func (*Headers) GetContentEncoding

func (h *Headers) GetContentEncoding() (ContentEncoding, error)

func (*Headers) GetContentType

func (h *Headers) GetContentType() (string, error)

type Store

type Store interface {
	// Store stores an object in the store.
	//
	// The key is the identifier for the object.
	// The reader is the object to store.
	// The headers are optional metadata about the object.
	Store(ctx context.Context, key string, reader io.Reader, headers *Headers) error

	// Load loads an object from the store.
	//
	// The key is the identifier for the object.
	// The headers are optional metadata about the object.
	// It is the responsibility of the caller to close the returned reader
	Load(ctx context.Context, key string) (io.ReadCloser, *Headers, error)

	// Delete deletes an object from the store.
	Delete(ctx context.Context, key string) error

	// Copy copies an object from one store to another.
	Copy(ctx context.Context, srcKey, dstKey string) error
}

Store is an interface for storing and loading objects.

func NewNoOpStore

func NewNoOpStore() Store

NewNoOpStore returns a new no-op store.

func WithLog

func WithLog(store Store) Store

func WithMetrics

func WithMetrics(store Store) Store

func WithTags

func WithTags(store Store) Store