store

Documentation

Overview

Package store defines the interface of an object store service

Index

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

Variables

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

)

Types

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 store TODO: add metadata (e.g creation data, size)

func (Object) String

func (o Object) String() string

type ObjectStore

type ObjectStore interface {
	// Get retrieves an objects if exists in the store or an error otherwise
	Get(ctx context.Context, id string) (Object, error)
	// Put stores the object and returns the metadata
	Put(ctx context.Context, id string, content io.Reader) (Object, error)
}

ObjectStore defines an interface for storing and retrieving blobs