backend

Documentation

Index

• Variables
• type Backend
• type Factory

Variables

var BackendNameList = []string{"local", "s3", "git"}

BackendNameList is an ordered list of backend names for listing in help message.

var Backends = map[string]Factory{}

Backends associates backend type names to constructor functions.

Types

type Backend

type Backend interface {
	// Exists returns true if a store exists in the backend, false otherwise
	Exists() (bool, error)
	// Save persists encrypted data to the backend
	Save(data []byte) error
	// Load reads encrypted data from the backend
	Load() ([]byte, error)

	ExistsContext(ctx context.Context) (bool, error)
	SaveContext(ctx context.Context, data []byte) error
	LoadContext(ctx context.Context) ([]byte, error)
}

Backend implements the common backend operations.

type Factory

type Factory interface {
	// New returns an initialized backend from the given configuration
	New(conf map[string]interface{}) (Backend, error)
	NewContext(ctx context.Context, conf map[string]interface{}) (Backend, error)

	// Name returns a human-readable name for the backend
	Name() string
	// Description returns a short, human-readable description of the backend
	Description() string
	// Flags returns a pflag FlagSet containing the options related to the
	// backend
	Flags() *pflag.FlagSet
}

Factory can instantiate a new Backend with New, and other static backend-related functions.