storage

Documentation

Index

• Variables
• func MustRegister(name string, factory EngineFactoryFunc)
• func Register(name string, factory EngineFactoryFunc) error
• type Engine
  • func Build(uri string) (Engine, error)
• type EngineFactoryFunc

Variables

var (

	// ErrEngineAlreadyRegistered is raise dwhen trying to register an existent engine.
	ErrEngineAlreadyRegistered = errors.New("engine: storage engine already registered")
)

var ErrSecretNotFound = errors.New("engine: secret not found")

ErrSecretNotFound is raised when trying to access non-existing secret.

Functions

func MustRegister

func MustRegister(name string, factory EngineFactoryFunc)

MustRegister try to register the engine and panic on error.

func Register

func Register(name string, factory EngineFactoryFunc) error

Register a new storage engine.

Types

type Engine

type Engine interface {
	Get(ctx context.Context, id string) ([]byte, error)
}

Engine represents storage engine contract

func Build

func Build(uri string) (Engine, error)

Build an engine instance with given URL.

type EngineFactoryFunc

type EngineFactoryFunc func(*url.URL) (Engine, error)

EngineFactoryFunc is the storage engine factory contract.