statestore

README

go-statestore

A general-purpose key-value store for CBOR-encodable data

License

Dual-licensed under MIT + Apache 2.0

Documentation

Index

• func ToKey(k interface{}) datastore.Key
• type StateStore
  • func New(ds datastore.Datastore) *StateStore
  • func (st *StateStore) Begin(i interface{}, state interface{}) error
  • func (st *StateStore) Get(i interface{}) *StoredState
  • func (st *StateStore) Has(i interface{}) (bool, error)
  • func (st *StateStore) List(out interface{}) error
• type StoredState
  • func (st *StoredState) End() error
  • func (st *StoredState) Get(out cbg.CBORUnmarshaler) error
  • func (st *StoredState) Mutate(mutator interface{}) error

Functions

func ToKey

func ToKey(k interface{}) datastore.Key

Types

type StateStore

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

func New

func New(ds datastore.Datastore) *StateStore

func (*StateStore) Begin

func (st *StateStore) Begin(i interface{}, state interface{}) error

func (*StateStore) Get

func (st *StateStore) Get(i interface{}) *StoredState

func (*StateStore) Has

func (st *StateStore) Has(i interface{}) (bool, error)

func (*StateStore) List

func (st *StateStore) List(out interface{}) error

out: *[]T

type StoredState

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

func (*StoredState) End

func (st *StoredState) End() error

func (*StoredState) Get

func (st *StoredState) Get(out cbg.CBORUnmarshaler) error

func (*StoredState) Mutate

func (st *StoredState) Mutate(mutator interface{}) error

mutator func(*T) error