package states

Import Path
	/examples/tui/states (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	    ss_tui.go
	    states_utils.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type S = am.S ([])
		S is a type alias for a list of state names.

	 type State = am.State (struct)
		State is a type alias for a state definition. See [am.State].

	 type TuiGroupsDef (struct)
		TuiGroupsDef contains all the state groups Tui state-machine.

		As Types Of (only one)
			  var TuiGroups

	 type TuiStatesDef (struct)
		TuiStatesDef contains all the states of the Tui state-machine.

		Fields (total 11)
			BasicStatesDef *ss.BasicStatesDef
				inherit from BasicStatesDef

			BasicStatesDef.ErrHandlerTimeout string
				ErrHandlerTimeout indicates one of the state machine handlers has timed
				out.

			BasicStatesDef.ErrNetwork string
				ErrNetwork indicates a generic network error.

			BasicStatesDef.Healthcheck string
				Healthcheck is a periodic request making sure that the machine is still
				alive.

			BasicStatesDef.Heartbeat string
				Heartbeat is a periodic state that ensures the integrity of the machine.

			BasicStatesDef.Ready string
				Ready indicates the machine meets criteria to perform work.

			BasicStatesDef.Start string
				Start indicates the machine should be working. Removing start can force
				stop the machine.

			IncomingData string
			Resized string
			StatesBase *am.StatesBase
			StatesBase.Exception string
				Exception is the only built-in state and mean a global error. All errors
				have to [State.Require] the Exception state. If [Machine.PanicToErr] is
				true, Exception will receive it.

		Methods (total 4)
			( TuiStatesDef) Names() machine.S
			( TuiStatesDef) SetNames(names machine.S)
			( TuiStatesDef) SetStateGroups(groups map[string][]int, order []string)
			( TuiStatesDef) StateGroups() (map[string][]int, []string)
		Implements (at least one exported)
			 TuiStatesDef : github.com/pancsta/asyncmachine-go/pkg/machine.States
		As Types Of (only one)
			  var TuiStates


Package-Level Functions (only one)

	 func NewTui(ctx context.Context) *am.Machine
		NewTui creates a new Tui state-machine in the most basic form.


Package-Level Variables (total 8)

	  var Exception string
		Exception is a type alias for the exception state.

	  var SAdd func(states ...machine.S) machine.S
		SAdd is a func alias for merging lists of states.

	  var SchemaMerge func(schemas ...machine.Schema) machine.Schema
		SchemaMerge is a func alias for extending an existing state structure.

	  var StateAdd func(source machine.State, overlay machine.State) machine.State
		StateAdd is a func alias for adding to an existing state definition.

	  var StateSet func(source machine.State, auto bool, multi bool, overlay machine.State) machine.State
		StateSet is a func alias for replacing parts of an existing state
		definition.

	  var TuiGroups TuiGroupsDef
		TuiGroups contains all the state groups for the Tui state-machine.

	  var TuiSchema machine.Schema
		TuiSchema represents all relations and properties of TuiStates.

	  var TuiStates TuiStatesDef
		TuiStates contains all the states for the Tui state-machine.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.