cache

Documentation

Overview

Package cache defines the interface of a cache service

Index

• Variables
• type Cache
• type Object
  • func (o Object) String() string

Variables

var (
	ErrAccessingObject   = errors.New("accessing object")   //nolint:revive
	ErrCreatingObject    = errors.New("creating object")    //nolint:revive
	ErrInitializingCache = errors.New("initializing cache") //nolint:revive
	ErrObjectNotFound    = errors.New("object not found")   //nolint:revive
	ErrInvalidURL        = errors.New("invalid object URL") //nolint:revive

)

Types

type Cache

type Cache interface {
	// Get retrieves an objects if exists in the cache or an error otherwise
	Get(ctx context.Context, id string) (Object, error)
	// Store stores the object and returns the metadata
	Store(ctx context.Context, id string, content io.Reader) (Object, error)
	// Download returns the content of the object
	Download(ctx context.Context, object Object) (io.ReadCloser, error)
}

Cache defines an interface for storing blobs

type Object

type Object struct {
	ID       string
	Checksum string
	// an url for downloading the object's content
	URL string
}

Object represents an object stored in the Cache TODO: add metadata (e.g creation data, size)

func (Object) String

func (o Object) String() string