statestore

Documentation

Overview

Package statestore provides an abstraction on top of go-statestore that allows you to make a StateStore that tracks its own version and knows how to migrate itself to the target version

Index

• type StateStore
  • func NewMigratedStateStore(ss *statestore.StateStore, ms versioning.MigrationState) StateStore
  • func NewVersionedStateStore(ds datastore.Batching, migrations versioning.VersionedMigrationList, ...) (StateStore, func(context.Context) error)
• type StoredState

Types

type StateStore

type StateStore interface {
	Begin(i interface{}, state interface{}) error
	Get(i interface{}) StoredState
	Has(i interface{}) (bool, error)
	List(out interface{}) error
}

StateStore is a wrapper around a datastore for saving CBOR encoded structs

func NewMigratedStateStore

func NewMigratedStateStore(ss *statestore.StateStore, ms versioning.MigrationState) StateStore

NewMigratedStateStore returns an fsm whose functions will fail until the migration state says its ready

func NewVersionedStateStore

func NewVersionedStateStore(ds datastore.Batching, migrations versioning.VersionedMigrationList, target versioning.VersionKey) (StateStore, func(context.Context) error)

NewVersionedStateStore sets takes a datastore, fsm parameters, migrations list, and target version, and returns an fsm whose functions will fail till it's migrated to the target version and a function to run migrations

type StoredState

type StoredState interface {
	End() error
	Get(out cbg.CBORUnmarshaler) error
	Mutate(mutator interface{}) error
}

StoredState is an interface for accessing state