package states

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

Dependency Relation
	imports 2 packages, and imported by 3 packages

Involved Source Files

	    ss_example.go
	    states_utils.go
Package-Level Type Names (total 5)

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

		Fields (only one)
			Mutex S
		As Types Of (only one)
			  var ExampleGroups

	 type ExampleStatesDef (struct)
		ExampleStatesDef contains all the states of the Example state machine.

		Fields (total 7)
			Bar string
			Baz string
			Foo 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.

			StateSourceStatesDef *ssrpc.StateSourceStatesDef
				inherit from rpc/StateSourceStatesDef

			StateSourceStatesDef.ErrOnClient string
				ErrOnClient indicates an error added on the Network Machine.

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

	 type S = am.S ([])
		S is a type alias for a list of state names. See [am.S].

	 type Schema = am.Schema (map)
		Schema is a type alias for a map of state names to state definitions. See [am.Schema].

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


Package-Level Variables (total 6)

	  var ExampleGroups ExampleGroupsDef
		ExampleGroups contains all the state groups for the Example machine.

	  var ExampleSchema machine.Schema
		ExampleSchema represents all relations and properties of ExampleStates.
		inherit from rpc/WorkerSchema

	  var ExampleStates ExampleStatesDef
		ExampleStates contains all the states for the Example machine.

	  var Exception string
		Exception is a type alias for the Exception state. See [am.StateException].

	  var Ready string
		Ready is a type alias for the Ready state. See [am.StateReady].

	  var Start string
		Start is a type alias for the Start state. See [am.StateStart].

The pages are generated with Golds v0.8.4. (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.