state

package

v0.12.0 Latest Latest Go to latest Published: Sep 8, 2026 License: MIT Imports: 3 Imported by: 0

Details

View Source

const (
	Creating = "creating"
	Active   = "active"
	Inactive = "inactive"
	Deleting = "deleting"
	Failed   = "failed"
)

Shared resource lifecycle states. Domain-specific state machines add only states that do not describe a general resource lifecycle.

This section is empty.

This section is empty.

type Edge string

Edge represents a state transition edge. The transition must be a string with an arrow, for example "requested -> approved".

func (e Edge) Value() ([]string, string)

Value parses the edge and returns a source and destination pair.

type Machine map[string]Edge

Machine represents a finite state machine keyed by action name.

func (m Machine) CanTransition(from, to string) bool

CanTransition reports whether a transition from one state to another is allowed.

func (m Machine) Default() string

Default returns the default state. If no default state was configured it returns an empty string.

func (m Machine) States() []string

States returns a list of all possible states in the machine.

func (m Machine) TryAction(action, current string) (string, bool)

TryAction attempts to transition from a current state.