package states

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

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	  d ss_cli.go
		Package states contains a stateful schema-v2 for a CLI.
		Bootstrapped with am-gen. Edit manually or re-gen & merge.
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type CliGroupsDef (struct)
		CliGroupsDef contains all the state groups Cli state machine.

		As Types Of (only one)
			  var CliGroups

	 type CliStatesDef (struct)
		CliStatesDef contains all the states of the Cli state machine.

		Fields (total 15)
			Bar2 string
			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.

			DisposedStatesDef *ss.DisposedStatesDef
				inherit from DisposedStatesDef

			DisposedStatesDef.Disposed string
				Disposed indicates that the machine has disposed allocated resources
				and is ready to be garbage collected by calling [am.Machine.Dispose].

			DisposedStatesDef.Disposing string
				Disposing starts the machine disposal - first state-based and then calls
				[am.Machine.Dispose].

			DisposedStatesDef.RegisterDisposal string
				RegisterDisposal registers a disposal handler passed under the
				DisposedArgHandler key. Requires [DisposedHandlers] to be bound prior to
				the registration. Handlers registered via RegisterDisposal can block.

			Foo1 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)
			( CliStatesDef) Names() machine.S
			( CliStatesDef) SetNames(names machine.S)
			( CliStatesDef) SetStateGroups(groups map[string][]int, order []string)
			( CliStatesDef) StateGroups() (map[string][]int, []string)
		Implements (at least one exported)
			 CliStatesDef : github.com/pancsta/asyncmachine-go/pkg/machine.States
		As Types Of (only one)
			  var CliStates


Package-Level Variables (total 3)

	  var CliGroups CliGroupsDef
		CliGroups contains all the state groups for the Cli machine.

	  var CliSchema machine.Schema
		CliSchema represents all relations and properties of CliStates.

	  var CliStates CliStatesDef
		CliStates contains all the states for the Cli 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.