package repl

Import Path
	/tools/repl (on go.dev)

Dependency Relation
	imports 30 packages, and imported by one package

Involved Source Files

	    cli_repl.go
	    misc_repl.go
	  d repl.go
		Package repl provides a REPL and CLI functionality for aRPC connections.
Package-Level Type Names (total 9)

	/* sort by: alphabet | popularity */
	 type A (struct)
		A is a struct for node arguments. It's a typesafe alternative to [am.A].

		Fields (total 13)
			Addrs []string
			Args Args
			Args.ArgsBase am.ArgsBase
			Args.ArgsBase.ArgsApi machine.ArgsApi
			CliArgs []string
				Arguments passed to the CLI from the shell

			Id string
			Lines []string
			ListFilters *ListFilters
			MachId string
				machine ID

			MachIds []string
				list of machine IDs

			MutArgs [2][]string
				Mutation arguments passed from a Cobra cmd handler.

			RpcCh chan<- []*rpc.Client
				RpcCh is a return channel for a list of [rpc.NetworkMachine]. It has to be
				buffered or the mutation will fail.

			States []string
		Methods (total 3)
			( A) ArgsPrefix() string
			( A) ArgsState() string
				State is the default Any state.

			( A) Clone() machine.ArgsApi
				Clone for deep cloning.

		Implements (at least one exported)
			 A : github.com/pancsta/asyncmachine-go/pkg/machine.ArgsApi

	 type Args (struct)
		Args is shared pkg args for Any state

		Fields (total 2)
			ArgsBase am.ArgsBase
			ArgsBase.ArgsApi machine.ArgsApi
		Methods (total 3)
			( Args) ArgsPrefix() string
			( Args) ArgsState() string
				State is the default Any state.

			( Args) Clone() machine.ArgsApi
				Clone for deep cloning.

		Implements (at least one exported)
			 Args : github.com/pancsta/asyncmachine-go/pkg/machine.ArgsApi

	 type History (struct)

		Methods (total 4)
			(*History) Dump() interface{}
				Dump returns the entire history file.

			(*History) GetLine(pos int) (string, error)
				GetLine returns a specific line from the history file.

			(*History) Len() int
				Len returns the number of items in the history file.

			(*History) Write(s string) (int, error)
				Write item to history file.

		Implements (at least one exported)
			*History : github.com/reeflective/readline/internal/history.Source

	 type HistoryItem (struct)

		Fields (total 3)
			Block string
			DateTime time.Time
			Index int

	 type ListFilters (struct)
		TODO merge with pkg/pubsub and pkg/integrations
		TODO extract to pkg/helpers.Group

		Fields (total 15)
			IdExact string
			IdPrefix string
			IdRegexp *regexp.Regexp
			IdSubstr string
			IdSuffix string
			Limit int
			MtimeMax uint64
			MtimeMin uint64
			MtimeStates S
			NoSchema bool
				Include never connected machines

			Parent string
			SkipDisconn bool
				Exclude disconnected machines

			StartIdx int
			StatesActive S
			StatesInactive S
		As Inputs Of (at least one exported)
			func (*Repl).ListMachines(filters *ListFilters) ([]*arpc.Client, error)

	 type Repl (struct)

		Fields (total 6)
			Addrs []string
				Addrs ending with /* are WebSockets
				TODO keep NAMED addresses eg CLI0, filename1, filename2, CLI1
				 and manipulate when watching for changes, keeping the prev ones

			C *console.Console
			Cmd *cobra.Command
			DbgAddr string
				am-dbg address for new clients

			ExceptionHandler *am.ExceptionHandler
				TODO JSON output

			Mach *am.Machine
		Methods (total 36)
			(*Repl) AddrChangedEnter(e *am.Event) bool
			(*Repl) AddrChangedState(e *am.Event)
				TODO avoid a full restart

			(*Repl) CmdAddEnter(e *am.Event) bool
			(*Repl) CmdAddState(e *am.Event)
			(*Repl) CmdGroupAddEnter(e *am.Event) bool
			(*Repl) CmdGroupAddState(e *am.Event)
			(*Repl) CmdGroupRemoveEnter(e *am.Event) bool
			(*Repl) CmdGroupRemoveState(e *am.Event)
			(*Repl) CmdRemoveEnter(e *am.Event) bool
			(*Repl) CmdRemoveState(e *am.Event)
			(*Repl) ConnectedExit(e *am.Event) bool
			(*Repl) ConnectedFullyEnter(e *am.Event) bool
			(*Repl) ConnectedFullyExit(e *am.Event) bool
			(*Repl) ConnectedState(e *am.Event)
			(*Repl) ConnectingEnter(e *am.Event) bool
			(*Repl) ConnectingExit(e *am.Event) bool
			(*Repl) ConnectingState(e *am.Event)
			(*Repl) DisconnectedState(e *am.Event)
			(*Repl) DisconnectingState(e *am.Event)
			(*Repl) ErrNetworkState(e *am.Event)
			( Repl) ExceptionState(e *machine.Event)
				ExceptionState is a final entry handler for the StateException state.
				ArgsBase:
				- err error: The error that caused the StateException state.
				- panic *ExceptionArgsPanic: Optional details about the panic.

			(*Repl) ListMachines(filters *ListFilters) ([]*arpc.Client, error)
			(*Repl) ListMachinesEnter(e *am.Event) bool
			(*Repl) ListMachinesState(e *am.Event)
			(*Repl) NetMach(machId string) *arpc.NetworkMachine
				NetMach returns an RPC worker with a given ID, or nil.

			(*Repl) NetMachArgs(machId string) []string
				NetMachArgs returns a list of registered typed args for a given machine.

			(*Repl) Print(txt string, args ...any)
			(*Repl) PrintErr(txt string, args ...any)
			(*Repl) PrintMsg(txt string, args ...any)
				PrintMsg prints a message about the prompt.

			(*Repl) ReplModeState(e *am.Event)
			(*Repl) RpcConnEnter(e *am.Event) bool
			(*Repl) RpcConnState(e *am.Event)
			(*Repl) RpcDisconnEnter(e *am.Event) bool
			(*Repl) RpcDisconnState(e *am.Event)
			(*Repl) StartEnter(e *am.Event) bool
			(*Repl) StartState(e *am.Event)
		Implements (at least one exported)
			*Repl : ReplApi
		As Outputs Of (at least one exported)
			func New(ctx context.Context, id string) (*Repl, error)
		As Inputs Of (at least 6)
			func InspectingCmds(repl *Repl) []*cobra.Command
			func MutationCmds(repl *Repl) []*cobra.Command
			func NewRootCommand(repl *Repl, cliArgs, osArgs []string) *cobra.Command
			func ReplCmds(repl *Repl) []*cobra.Command
			func SysCmds(repl *Repl) []*cobra.Command
			func WaitingCmds(repl *Repl) []*cobra.Command

	 type ReplApi (interface)

		Methods (only one)
			( ReplApi) NetMachArgs(machId string) []string
		Implemented By (at least one exported)
			*Repl
		As Inputs Of (at least one exported)
			func MutationFlags(repl ReplApi, cmd *cobra.Command, groupCmd bool)

	 type S = am.S ([])
	 type T = am.Time ([])
Package-Level Functions (total 10)

	 func AddErrSyntax(event *am.Event, mach *am.Machine, err error, args am.A) error
		AddErrSyntax wraps an error in the ErrSyntax sentinel and adds to a machine.

	 func InspectingCmds(repl *Repl) []*cobra.Command
	 func ListingFlags(cmd *cobra.Command)
	 func MutationCmds(repl *Repl) []*cobra.Command
	 func MutationFlags(repl ReplApi, cmd *cobra.Command, groupCmd bool)
	 func New(ctx context.Context, id string) (*Repl, error)
	 func NewRootCommand(repl *Repl, cliArgs, osArgs []string) *cobra.Command
	 func ReplCmds(repl *Repl) []*cobra.Command
	 func SysCmds(repl *Repl) []*cobra.Command
	 func WaitingCmds(repl *Repl) []*cobra.Command
Package-Level Variables (total 3)

	  var ErrSyntax error
	  var Pass func(args ...machine.ArgsApi) machine.A
	  var Sp func(txt string, args ...any) string
Package-Level Constants (only one)

	const APrefix = "am_repl"

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.