file

Documentation

Index

• func NewSnapshot(dir, name string) (store.Snapshot, error)
• func NewStore(typeName string, dir string) store.KV
• type Store
  • func (s *Store) Close() error
  • func (s *Store) Delete(key interface{}) error
  • func (s *Store) Entries() (<-chan store.Pair, error)
  • func (s *Store) Exists(key interface{}) (bool, error)
  • func (s *Store) Key(key interface{}) string
  • func (s *Store) Read(key interface{}) ([]byte, error)
  • func (s *Store) Write(key interface{}, value []byte) error

Functions

func NewSnapshot

func NewSnapshot(dir, name string) (store.Snapshot, error)

NewSnapshot returns an instance of the snapshot service where data is stored in the directory given. This is a simple implementation that assumes a single file for the entire snapshot.

func NewStore

func NewStore(typeName string, dir string) store.KV

NewStore creates a store of object with a typeName in the given directory. Instances of the type will be stored as files in this directory and named accordingly.

Types

type Store

type Store struct {
	Dir string

	// IDFunc is the function that generates the id.
	IDFunc func(interface{}) string
	// contains filtered or unexported fields
}

Store is an abstraction for writing and reading from entries in a file directory.

func (*Store) Close

func (s *Store) Close() error

Close implements io.Closer

func (*Store) Delete

func (s *Store) Delete(key interface{}) error

Delete deletes the object by id

func (*Store) Entries

func (s *Store) Entries() (<-chan store.Pair, error)

Entries returns the entries

func (*Store) Exists

func (s *Store) Exists(key interface{}) (bool, error)

Exists checks for existence

func (*Store) Key

func (s *Store) Key(key interface{}) string

Key returns an id given the key. The id contains type, etc.

func (*Store) Read

func (s *Store) Read(key interface{}) ([]byte, error)

Read checks for existence

func (*Store) Write

func (s *Store) Write(key interface{}, value []byte) error

Write writes the object and returns an id or error.