storage

Documentation

Index

• Variables
• func Init() error
• func IsErrInvalidConfiguration(err error) bool
• func RegisterStorageGenerator(typ Type, generator Generator)
• func ToConfig(exampler, cfg interface{}) (interface{}, error)
• type ErrInvalidConfiguration
  • func (e ErrInvalidConfiguration) Error() string
• type Generator
• type ID
• type Marshaler
• type Object
• type ReadOption
• type ReadOptions
• type Storage
  • func NewStorage(typ string, cfg interface{}) (Storage, error)
• type Type
• type WriteOption
  • func WithID(id uint) WriteOption
• type WriteOptions

Variables

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

Functions

func Init

func Init() error

func IsErrInvalidConfiguration

func IsErrInvalidConfiguration(err error) bool

func RegisterStorageGenerator

func RegisterStorageGenerator(typ Type, generator Generator)

func ToConfig

func ToConfig(exampler, cfg interface{}) (interface{}, error)

Types

type ErrInvalidConfiguration

type ErrInvalidConfiguration struct {
	// contains filtered or unexported fields
}

func (ErrInvalidConfiguration) Error

func (e ErrInvalidConfiguration) Error() string

type Generator

type Generator func(context.Context, interface{}) (Storage, error)

type ID

type ID string

type Marshaler

type Marshaler interface {
	Unmarshal(v interface{}) error
}

type Object

type Object struct {
	Name   string
	Size   int64
	Reader io.ReadCloser
}

type ReadOption

type ReadOption func(*ReadOptions)

type ReadOptions

type ReadOptions struct {
}

type Storage

type Storage interface {
	Write(f *Object, opts ...WriteOption) (ID, error)
	Read(id ID, opts ...ReadOption) (*Object, error)
	Delete(id ID) error
}

var (
	LFS Storage
)

func NewStorage

func NewStorage(typ string, cfg interface{}) (Storage, error)

type Type

type Type string

type WriteOption

type WriteOption func(*WriteOptions)

func WithID

func WithID(id uint) WriteOption

type WriteOptions

type WriteOptions struct {
	ID uint
}