persistent

Documentation

Index

• Constants
• Variables
• type Ledger
  • func (l *Ledger) Close(delete bool) error
  • func (l *Ledger) Log(t uint32, v []byte) error
• type PersistentStorageApi
• type PersistentStorageIteratorApi
• type PersistentStorageProvider
  • func NewJsonFilePersistentStorageProvider(filename string) PersistentStorageProvider
  • func NewLocalPersistentStorageProvider() PersistentStorageProvider
• type PersistentStorageTransactionApi
  • func NewBase64PersistentStorageTransaction(data map[string]string) PersistentStorageTransactionApi
• type Registry
• type ReplayHandler
• type Store
  • func Open(path string, readOnly bool) (*Store, error)
  • func (s *Store) Close() error
  • func (s *Store) DeleteKey(key string) error
  • func (s *Store) MakeKey(registry Registry, id string) string
  • func (s *Store) NewKey(key string, metadata []byte) (*Ledger, error)
  • func (s *Store) OpenKey(key string) (*Ledger, error)
  • func (s *Store) Register(registries []Registry)
  • func (s *Store) Replay() error

Constants

const (
	KeyPrefixLength = 2
)

Variables

var ErrRegistryNotFound = errors.New("registry not found")

var StorageProvider = NewLocalPersistentStorageProvider()

Types

type Ledger

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

func (*Ledger) Close

func (l *Ledger) Close(delete bool) error

func (*Ledger) Log

func (l *Ledger) Log(t uint32, v []byte) error

type PersistentStorageApi

type PersistentStorageApi interface {
	View(func(txn PersistentStorageTransactionApi) error) error
	Update(func(txn PersistentStorageTransactionApi) error) error
	Delete(key string) error

	Close() error
}

Persistent Storage API provides an interface for interacting with persistent storage

type PersistentStorageIteratorApi

type PersistentStorageIteratorApi interface {
	Rewind()
	Valid() bool
	Next()

	Key() string
	Value() ([]byte, error)

	Close()
}

Persistent Storage Iterator API provides an iterface for interacting with persistent storage iterators

type PersistentStorageProvider

type PersistentStorageProvider interface {
	NewPersistentStorageInterface(path string, readOnly bool) (PersistentStorageApi, error)
}

func NewJsonFilePersistentStorageProvider

func NewJsonFilePersistentStorageProvider(filename string) PersistentStorageProvider

func NewLocalPersistentStorageProvider

func NewLocalPersistentStorageProvider() PersistentStorageProvider

type PersistentStorageTransactionApi

type PersistentStorageTransactionApi interface {
	NewIterator(prefix string) PersistentStorageIteratorApi
	Set(key string, value []byte) error
	Get(key string) ([]byte, error)
}

Persistent Storage Transaction API provides an interface for interacting with persistent storage transactions

func NewBase64PersistentStorageTransaction

func NewBase64PersistentStorageTransaction(data map[string]string) PersistentStorageTransactionApi

type Registry

type Registry interface {
	Prefix() string
	NewReplay(id string) ReplayHandler
}

type ReplayHandler

type ReplayHandler interface {
	Metadata(data []byte) error
	Entry(t uint32, data []byte) error
	Done() (bool, error)
}

type Store

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

func Open

func Open(path string, readOnly bool) (*Store, error)

func (*Store) Close

func (s *Store) Close() error

func (*Store) DeleteKey

func (s *Store) DeleteKey(key string) error

func (*Store) MakeKey

func (s *Store) MakeKey(registry Registry, id string) string

func (*Store) NewKey

func (s *Store) NewKey(key string, metadata []byte) (*Ledger, error)

NewKey will create the provided key with metadata provided. It returns a logger which tracks updates to the key's value.

func (*Store) OpenKey

func (s *Store) OpenKey(key string) (*Ledger, error)

func (*Store) Register

func (s *Store) Register(registries []Registry)

func (*Store) Replay

func (s *Store) Replay() error