storage

Documentation

Overview

Package storage provides utilities and facades to interact with storage engines

Index

• Variables
• func DefaultReleaseTimer(driver Driver, id uuid.UUID, duration time.Duration) <-chan error
• func NewCallbackWriteCloser(w io.Writer, callback func(w io.Writer) error) io.WriteCloser
• func RegisterDriver(name string, factory DriverFactory)
• func RemoveDriver(name string)
• type CallbackWriteCloser
  • func (cwc *CallbackWriteCloser) Close() error
  • func (cwc *CallbackWriteCloser) Write(p []byte) (n int, err error)
• type Driver
  • func NewDriver(name string, conf DriverConfigure) (Driver, error)
• type DriverConfigure
• type DriverFactory

Variables

var ErrAlreadyExist error = fmt.Errorf("object already exist")

var ErrDriverNotFound error = fmt.Errorf("Driver not found")

var ErrNotExist error = fmt.Errorf("object not exist")

Functions

func DefaultReleaseTimer

func DefaultReleaseTimer(driver Driver, id uuid.UUID, duration time.Duration) <-chan error

func NewCallbackWriteCloser

func NewCallbackWriteCloser(w io.Writer, callback func(w io.Writer) error) io.WriteCloser

func RegisterDriver

func RegisterDriver(name string, factory DriverFactory)

func RemoveDriver

func RemoveDriver(name string)

Types

type CallbackWriteCloser

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

func (*CallbackWriteCloser) Close

func (cwc *CallbackWriteCloser) Close() error

func (*CallbackWriteCloser) Write

func (cwc *CallbackWriteCloser) Write(p []byte) (n int, err error)

type Driver

type Driver interface {
	// GetName returns the name of the interface
	GetName() string
	// NewObject creates a new object in the storage
	NewObject(id uuid.UUID) (io.WriteCloser, error)
	// GetObject retrieves an object in the storage
	GetObject(id uuid.UUID) (io.ReadCloser, error)
	// IsExist returns if an object exists
	IsExist(id uuid.UUID) (bool, error)
	// ReleaseObject releases an object in the storage
	ReleaseObject(id uuid.UUID) error
	// SetExpire sets an expire duration for an exact object
	SetExpire(id uuid.UUID, expire time.Duration) <-chan error
}

Driver defines storage driver interface

func NewDriver

func NewDriver(name string, conf DriverConfigure) (Driver, error)

type DriverConfigure

type DriverConfigure map[string]interface{}

type DriverFactory

type DriverFactory func(conf DriverConfigure) (Driver, error)