state_machine

package

v0.0.0-...-ba30bcd Latest Latest Go to latest Published: May 7, 2024 License: BSD-3-Clause Imports: 6 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

Builder is a helper struct used for constructing StateMachines.

func NewBuilder() *Builder

NewBuilder returns a Builder instance.

func (b *Builder) Build(ctx context.Context, gcsClient gcs.GCSClient, gsPath string) (*StateMachine, error)

Build and return a StateMachine instance.

func (b *Builder) F(name string, fn TransitionFn)

Add a transition function with the given name. Allows nil functions for no-op transitions.

func (b *Builder) SetInitial(s string)

Set the initial state.

func (b *Builder) T(from, to, fn string)

Add a transition between the two states with the given named function.

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

StateMachine is a simple state machine implementation which persists its current state to a file.

func (sm *StateMachine) Current() string

Return the current state.

func (sm *StateMachine) GetTransitionName(dest string) (string, error)

Return the name of the transition function from the current state to the given state.

func (sm *StateMachine) ListStates() []string

ListStates returns the list of all states in the StateMachine.

func (sm *StateMachine) Transition(ctx context.Context, dest string) error

Attempt to transition to the given state, using the transition function.

type TransitionFn func(ctx context.Context) error

TransitionFn is a function to run when attempting to transition from one State to another. It is okay to give nil as a noop TransitionFn.