snapmeta

Documentation

Overview

Package snapmeta describes entities that can accept arbitrary metadata and flush it to a persistent repository.

Index

• type Persister
  • func New(baseDir string) (Persister, error)
• type Simple
  • func NewSimple() *Simple
  • func (s *Simple) Delete(key string)
  • func (s *Simple) GetKeys() []string
  • func (s *Simple) Load(key string) ([]byte, error)
  • func (s *Simple) Store(key string, val []byte) error
• type Store

Types

type Persister

type Persister interface {
	Store
	snap.RepoManager
	LoadMetadata() error
	FlushMetadata() error
	Cleanup()
}

Persister describes the ability to flush metadata to, and load it again, from a repository.

func New

func New(baseDir string) (Persister, error)

New instantiates a new Persister and returns it.

type Simple

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

Simple is a snapstore implementation that stores snapshot metadata as a byte slice in a map in memory. A Simple should not be copied.

func NewSimple

func NewSimple() *Simple

NewSimple instantiates a new Simple snapstore and returns its pointer.

func (*Simple) Delete

func (s *Simple) Delete(key string)

Delete implements the Storer interface Delete method.

func (*Simple) GetKeys

func (s *Simple) GetKeys() []string

GetKeys implements the Storer interface GetKeys method.

func (*Simple) Load

func (s *Simple) Load(key string) ([]byte, error)

Load implements the Storer interface Load method.

func (*Simple) Store

func (s *Simple) Store(key string, val []byte) error

Store implements the Storer interface Store method.

type Store

type Store interface {
	Store(key string, val []byte) error
	Load(key string) ([]byte, error)
	Delete(key string)
	GetKeys() []string
}

Store describes the ability to store and retrieve a buffer of metadata, indexed by a string key.