state

Documentation

Index

• type State
  • func NewState(factory database.TxnRunnerFactory) *State
  • func (st *State) GetUnitState(ctx context.Context, name coreunit.Name) (unitstate.RetrievedUnitState, error)
  • func (st *State) SetUnitState(ctx context.Context, as unitstate.UnitState) error

Types

type State

type State struct {
	*domain.StateBase
}

State implements persistence for unit state.

func NewState

func NewState(factory database.TxnRunnerFactory) *State

NewState returns a new state reference.

func (*State) GetUnitState

func (st *State) GetUnitState(ctx context.Context, name coreunit.Name) (unitstate.RetrievedUnitState, error)

GetUnitState returns the full unit state. The state may be empty. If no unit with the namw exists, a errors.UnitNotFound error is returned.

func (*State) SetUnitState

func (st *State) SetUnitState(ctx context.Context, as unitstate.UnitState) error