package types

Import Path
	/tools/debugger/types (on go.dev)

Dependency Relation
	imports 22 packages, and imported by 9 packages

Involved Source Files

	    dbg_types.go
Package-Level Type Names (total 20)

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

		Fields (total 44)
			Addr string
			Amount int
			Args Args
			Args.ArgsBase am.ArgsBase
			Args.ArgsBase.ArgsApi machine.ArgsApi
			BuildClientList bool
			ClientId string
			Column int
			ConnId string
			ConnIds []string
			CurrTxRow int
			Cursor1 int
			CursorStep1 int
			CursorTx1 int
				TODO merge with Cursor1

			DiagDom *goquery.Document
				DiagDom is parsed HTML for diagram generation.

			DiagName string
				DiagName is the name of the diagram being generated.

			DiagType DiagramType
			DoneChan chan struct{}
				DoneChan signals completion of a web handler.

			FilterBack bool
			FilterTxs bool
			FocusPrimitive cview.Primitive
				FocusPrimitive is the UI element receiving focus.

			FromConnected bool
			FromPlaying bool
			Fwd bool
			Group string
			HttpRequest *http.Request
				HttpRequest is for web server route handlers.

			HttpResponseWriter http.ResponseWriter
				HttpResponseWriter is for web server route handlers.

			Id string
			Immediate bool
			LogBuffer string
			LogLevel am.LogLevel
			LogRebuildEnd int
				1-based index

			MouseFocus bool
			MsgStruct *dbg.DbgMsgStruct
				MsgStruct is the schema message from am-dbg protocol.

			MsgsTx []*dbg.DbgMsgTx
				MsgsTx is a batch of transaction messages.

			Row int
			SkipHistory bool
			State string
			Text string
			ToolName ToolName
			TrimHistory bool
			TxId string
			Uri string
			WebSocketConn *websocket.Conn
				WebSocketConn is for WebSocket handlers.

		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)

		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 ARpc (struct)
		ARpc is a subset of A, that can be passed over RPC.

		Fields (total 34)
			Addr string
			Amount int
			Args Args
			Args.ArgsBase am.ArgsBase
			Args.ArgsBase.ArgsApi machine.ArgsApi
			BuildClientList bool
			ClientId string
			Column int
			ConnId string
			ConnIds []string
			CurrTxRow int
			Cursor1 int
			CursorStep1 int
			CursorTx1 int
				TODO merge with Cursor1

			FilterBack bool
			FilterTxs bool
			FromConnected bool
			FromPlaying bool
			Fwd bool
			Group string
			Id string
			Immediate bool
			LogBuffer string
			LogLevel am.LogLevel
			LogRebuildEnd int
			MouseFocus bool
			Row int
			SkipHistory bool
			State string
			Text string
			ToolName ToolName
			TrimHistory bool
			TxId string
			Uri string
		Methods (total 3)
			( ARpc) ArgsPrefix() string
			( ARpc) ArgsState() string
				State is the default Any state.

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

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

	 type DiagramType (struct)
		DiagramType is a type of a diagram.

		Fields (only one)
			Value string
		Methods (only one)
			( DiagramType) String() string
		Implements (at least 2)
			 DiagramType : expvar.Var
			 DiagramType : fmt.Stringer
		As Types Of (total 4)
			  var DiagramTypeGraph
			  var DiagramTypeMach
			  var DiagramTypeState
			  var DiagramTypeSteps

	 type Filters (struct)
		Filters controls which transitions and log entries are shown.

		Fields (total 10)
			LogLevel am.LogLevel
			SkipAutoCanceledTx bool
			SkipAutoTx bool
			SkipCanceledTx bool
			SkipChecks bool
			SkipEmptyTx bool
			SkipHealthTx bool
			SkipOutGroup bool
			SkipQueuedTx bool
			SkipRpcMach bool
		Methods (only one)
			(*Filters) Equal(filters *Filters) bool
		As Inputs Of (at least one exported)
			func (*Filters).Equal(filters *Filters) bool

	 type LogReaderEntry (struct)

		Fields (total 9)
			Args string
				Args is for logReaderWhenArgs only

			ClosedAt time.Time
				ClosedAt is human time when this entry was closed, so it can be disposed.

			CreatedAt uint64
				CreatedAt is machine time when this entry was created

			Kind LogReaderKind
			Mach string
				Mach is for logReaderPipeIn, logReaderPipeOut, logReaderMention

			Pipe am.MutationType
				Pipe is for logReaderPipeIn, logReaderPipeOut

			QueueTick int
				QueueTick is for logReaderWhenQueue only

			States []int
				states are empty for logReaderWhenQueue

			Ticks am.Time
				Ticks is for logReaderWhenTime only

		As Outputs Of (at least one exported)
			func github.com/pancsta/asyncmachine-go/tools/debugger.(*Client).GetReaderEntry(txId string, idx int) *LogReaderEntry
		As Inputs Of (at least one exported)
			func github.com/pancsta/asyncmachine-go/tools/debugger.(*Client).AddReaderEntry(txId string, entry *LogReaderEntry) int

	 type LogReaderEntryPtr (struct)

		Fields (total 2)
			EntryIdx int
			TxId string

	 type LogReaderKind int (basic type)

		As Types Of (total 8)
			const LogReaderCtx
			const LogReaderPipeIn
			const LogReaderPipeOut
			const LogReaderWhen
			const LogReaderWhenArgs
			const LogReaderWhenNot
			const LogReaderWhenQueue
			const LogReaderWhenTime

	 type MachAddress (struct)

		Fields (total 8)
			Group string
				selected group

			HumanTime time.Time
			MachId string
			MachTime uint64
			QueueTick uint64
			State string
				selected state

			Step int
				TODO remove

			TxId string
		Methods (total 3)
			(*MachAddress) Clone() *MachAddress
			(*MachAddress) String() string
				String returns a full mach URL.

			(*MachAddress) StringBase() string
				StringBase returns a mach URL without GET params (unless no tx ID). Empty
				string ret if no link.

		Implements (at least 2)
			*MachAddress : expvar.Var
			*MachAddress : fmt.Stringer
		As Outputs Of (at least 3)
			func ParseMachUrl(u string) (*MachAddress, error)
			func (*MachAddress).Clone() *MachAddress
			func github.com/pancsta/asyncmachine-go/tools/debugger.(*Debugger).MachAddr() *MachAddress
		As Inputs Of (at least one exported)
			func github.com/pancsta/asyncmachine-go/tools/debugger.(*Debugger).GoToMachAddress(addr *MachAddress, skipHistory bool) bool

	 type MachTime (struct)

		Fields (total 2)
			Id string
			Time uint64

	 type MsgSchemaParsed (struct)

		Fields (total 3)
			Groups map[string]am.S
				TODO split to group ID, labels

			GroupsOrder []string
			Hash string

	 type MsgTxParsed (struct)

		Fields (total 9)
			Forks []MachAddress
				Transitions which reported this one as their source

			ForksLabels []string
			ReaderEntries []*LogReaderEntryPtr
			ResultTick uint64
				QueueTick when this tx should be executed

			StatesAdded []int
			StatesRemoved []int
			StatesTouched []int
			TimeDiff uint64
			TimeSum uint64
				TimeSum is machine time after this transition.

		As Outputs Of (at least one exported)
			func github.com/pancsta/asyncmachine-go/tools/debugger/server.(*Client).TxParsed(idx int) *MsgTxParsed

	 type Params (struct)
		Params are CLI params for am-dbg, also used as internal state via Debugger.Params.

		Fields (total 60)
			AddrHttp string
				AddrHttp is the computed HTTP server address (ListenAddr port+1).

			AddrRpc string
				AddrRpc is the RPC listen address (same as ListenAddr).

			AddrSsh string
				AddrSsh is the computed SSH server address (ListenAddr port+2).

			CleanOnConnect bool
			DbgLogger *log.Logger
				DbgLogger is the file logger for this instance.

			DbgOtel bool
			DebugAddr string
			EnableClipboard bool
			EnableMouse bool
			FilterAutoCanceledTx bool
			FilterAutoTx bool
			FilterCanceledTx bool
			FilterChecks bool
			FilterDisconn bool
			FilterEmptyTx bool
			FilterGroup bool
			FilterHealthTx bool
			FilterLogLevel am.LogLevel
			FilterQueuedTx bool
			FilterRpcMachs bool
			Filters *Filters
				Filters is the active set of transition filters.

			FwdData []string
			Id string
				Id is the ID of this asyncmachine (for debugging).

			ImportData string
			ListenAddr string
			LogLevel am.LogLevel
				LogLevel is the log level of this instance (for debugging).

			LogOpsTtl time.Duration
			MachUrl string
			MaxMemMb int
			OutputCallLog bool
			OutputClients bool
			OutputDiagGroup ParamsOutDiagGroup
			OutputDiagTx ParamsOutDiagTx
			OutputDiagrams ParamsOutputDiagrams
			OutputDir string
			OutputGraph bool
			OutputLog bool
			OutputTx bool
			Print func(txt string, args ...any)
				Print is the output function for status messages

			PrintVersion bool
			ProfCpu bool
			ProfMem bool
			ProfSrv string
			RaceDetector bool
			Repl bool
			Screen tcell.Screen
				Screen is an optional tcell screen override (tests, SSH).

			SelectConnected bool
			StartupView string
			TailMode bool
			UiMcp bool
			UiSsh bool
			UiWeb bool
			Version string
				Version is the computed build version string.

			ViewExpandLinks bool
			ViewLogWrap bool
			ViewNarrow bool
			ViewRain bool
			ViewReader bool
			ViewTheme string
			ViewTimelines ParamsViewTimelines
		As Inputs Of (at least 7)
			func GetLogger(params *Params, dir string) *log.Logger
			func HandleProfMem(logger *log.Logger, p *Params)
			func StartCpuProfile(logger *log.Logger, p *Params) func()
			func StartCpuProfileSrv(ctx context.Context, logger *log.Logger, p *Params)
			func github.com/pancsta/asyncmachine-go/tools/debugger.New(ctx context.Context, p Params) (*debugger.Debugger, error)
			func github.com/pancsta/asyncmachine-go/tools/debugger/server.New(mach *am.Machine, addr string, p Params) (cmux.CMux, *http.Server, error)
			func github.com/pancsta/asyncmachine-go/internal/testing.NewDbgWorker(realTty bool, p Params) (*debugger.Debugger, error)

	 type ParamsOutDiagGroup (struct)
		ParamsOutDiagGroup is an enum for --output-diagrams-group

		Fields (only one)
			Value string
		Methods (only one)
			(*ParamsOutDiagGroup) UnmarshalText(b []byte) error
		Implements (at least one exported)
			*ParamsOutDiagGroup : encoding.TextUnmarshaler
		As Types Of (total 3)
			  var ParamsOutDiagGroupHide
			  var ParamsOutDiagGroupNone
			  var ParamsOutDiagGroupSkip

	 type ParamsOutDiagTx (struct)
		ParamsOutDiagTx is an enum for --output-diagrams-group

		Fields (only one)
			Value string
		Methods (only one)
			(*ParamsOutDiagTx) UnmarshalText(b []byte) error
		Implements (at least one exported)
			*ParamsOutDiagTx : encoding.TextUnmarshaler
		As Types Of (total 5)
			  var ParamsOutDiagTxCalled
			  var ParamsOutDiagTxMutated
			  var ParamsOutDiagTxNone
			  var ParamsOutDiagTxRelations
			  var ParamsOutDiagTxTouched

	 type ParamsOutputDiagrams (struct)
		ParamsOutputDiagrams is an enum for --output-diagrams

		Fields (only one)
			Value int
		Methods (only one)
			(*ParamsOutputDiagrams) UnmarshalText(b []byte) error
		Implements (at least one exported)
			*ParamsOutputDiagrams : encoding.TextUnmarshaler
		As Types Of (total 4)
			  var ParamsOutputDiagramsNone
			  var ParamsOutputDiagramsOne
			  var ParamsOutputDiagramsThree
			  var ParamsOutputDiagramsTwo

	 type ParamsViewTimelines (struct)
		ParamsViewTimelines is an enum for --view-timelines

		Fields (only one)
			Value int
		Methods (only one)
			(*ParamsViewTimelines) UnmarshalText(b []byte) error
		Implements (at least one exported)
			*ParamsViewTimelines : encoding.TextUnmarshaler
		As Types Of (total 3)
			  var ParamsViewTimelinesNone
			  var ParamsViewTimelinesOne
			  var ParamsViewTimelinesTwo

	 type StateTraceItem (struct)

		Fields (total 3)
			Label string
			Source *MachAddress
			StateNames am.S

	 type ToolName (struct)
		ToolName is a debugger's toolbar button.

		Fields (only one)
			Value string
		As Types Of (total 40)
			  var ToolCallLog
			  var ToolDiagrams
			  var ToolDiagramsGroup
			  var ToolDiagramsTx
			  var ToolExpand
			  var ToolExport
			  var ToolFilterAutoTx
			  var ToolFilterCanceledTx
			  var ToolFilterChecks
			  var ToolFilterDisconn
			  var ToolFilterEmptyTx
			  var ToolFilterHealth
			  var ToolFilterOutGroup
			  var ToolFilterQueuedTx
			  var ToolFilterRpcMachs
			  var ToolFilterTraces
			  var ToolFirst
			  var ToolHelp
			  var ToolJumpNext
			  var ToolJumpPrev
			  var ToolLast
			  var ToolLog
			  var ToolLogTimestamps
			  var ToolLogWrap
			  var ToolMatrix
			  var ToolNarrowLayout
			  var ToolNext
			  var ToolNextClient
			  var ToolNextStep
			  var ToolOutputLog
			  var ToolOutputTx
			  var ToolPlay
			  var ToolPrev
			  var ToolPrevClient
			  var ToolPrevStep
			  var ToolRain
			  var ToolReader
			  var ToolTail
			  var ToolTimelines
			  var ToolWeb

	 type WsDiagMsg (struct)

		Fields (total 3)
			Event string
				ID of this event (eg refresh)

			Group string
			Id string
				ID of this diagram (eg mach ID, state name...)



Package-Level Functions (total 6)

	 func GetLogger(params *Params, dir string) *log.Logger
		GetLogger returns a file logger, according to params.

	 func HandleProfMem(logger *log.Logger, p *Params)
	 func NormalizeGroupName(name string) string
		TODO

	 func ParseMachUrl(u string) (*MachAddress, error)
	 func StartCpuProfile(logger *log.Logger, p *Params) func()
	 func StartCpuProfileSrv(ctx context.Context, logger *log.Logger, p *Params)
Package-Level Variables (total 66)

	  var ArgsRpc []machine.ArgsApi
		ArgsRpc will be available in the REPL.

	  var DiagramTypeGraph DiagramType
	  var DiagramTypeMach DiagramType
	  var DiagramTypeState DiagramType
	  var DiagramTypeSteps DiagramType
	  var ParamsOutDiagGroupEnum enum.Enum[...]
		"", "hide", "skip"

	  var ParamsOutDiagGroupHide ParamsOutDiagGroup
		"", "hide", "skip"

	  var ParamsOutDiagGroupNone ParamsOutDiagGroup
		"", "hide", "skip"

	  var ParamsOutDiagGroupSkip ParamsOutDiagGroup
		"", "hide", "skip"

	  var ParamsOutDiagTxCalled ParamsOutDiagTx
		"", "called", "changed", "touched"

	  var ParamsOutDiagTxEnum enum.Enum[...]
		"", "called", "changed", "touched"

	  var ParamsOutDiagTxMutated ParamsOutDiagTx
		"", "called", "changed", "touched"

	  var ParamsOutDiagTxNone ParamsOutDiagTx
		"", "called", "changed", "touched"

	  var ParamsOutDiagTxRelations ParamsOutDiagTx
		"", "called", "changed", "touched"

	  var ParamsOutDiagTxTouched ParamsOutDiagTx
		"", "called", "changed", "touched"

	  var ParamsOutputDiagramsEnum enum.Enum[...]
		0, 1, 2, 3

	  var ParamsOutputDiagramsNone ParamsOutputDiagrams
		0, 1, 2, 3

	  var ParamsOutputDiagramsOne ParamsOutputDiagrams
		0, 1, 2, 3

	  var ParamsOutputDiagramsThree ParamsOutputDiagrams
		0, 1, 2, 3

	  var ParamsOutputDiagramsTwo ParamsOutputDiagrams
		0, 1, 2, 3

	  var ParamsViewTimelinesEnum enum.Enum[...]
		0, 1, 2

	  var ParamsViewTimelinesNone ParamsViewTimelines
		0, 1, 2

	  var ParamsViewTimelinesOne ParamsViewTimelines
		0, 1, 2

	  var ParamsViewTimelinesTwo ParamsViewTimelines
		0, 1, 2

	  var StateCalls []machine.CallSignature
		StateCalls is a list binding args to state names.

	  var ToolCallLog ToolName
	  var ToolDiagrams ToolName
	  var ToolDiagramsGroup ToolName
	  var ToolDiagramsTx ToolName
	  var ToolExpand ToolName
	  var ToolExport ToolName
	  var ToolFilterAutoTx ToolName
	  var ToolFilterCanceledTx ToolName
	  var ToolFilterChecks ToolName
	  var ToolFilterDisconn ToolName
	  var ToolFilterEmptyTx ToolName
	  var ToolFilterHealth ToolName
	  var ToolFilterOutGroup ToolName
	  var ToolFilterQueuedTx ToolName
	  var ToolFilterRpcMachs ToolName
	  var ToolFilterTraces ToolName
	  var ToolFirst ToolName
	  var ToolHelp ToolName
	  var ToolJumpNext ToolName
	  var ToolJumpPrev ToolName
	  var ToolLast ToolName
	  var ToolLog ToolName
	  var ToolLogTimestamps ToolName
	  var ToolLogWrap ToolName
	  var ToolMatrix ToolName
	  var ToolNames enum.Enum[...]
	  var ToolNarrowLayout ToolName
	  var ToolNext ToolName
	  var ToolNextClient ToolName
	  var ToolNextStep ToolName
	  var ToolOutputLog ToolName
	  var ToolOutputTx ToolName
	  var ToolPlay ToolName
	  var ToolPrev ToolName
	  var ToolPrevClient ToolName
	  var ToolPrevStep ToolName
	  var ToolRain ToolName
	  var ToolReader ToolName
	  var ToolTail ToolName
	  var ToolTimelines ToolName
	  var ToolWeb ToolName
Package-Level Constants (total 9)

	const APrefix = "dbg"
	const LogReaderCtx LogReaderKind = 1
	const LogReaderPipeIn LogReaderKind = 7
	const LogReaderPipeOut LogReaderKind = 8
	const LogReaderWhen LogReaderKind = 2
	const LogReaderWhenArgs LogReaderKind = 5
	const LogReaderWhenNot LogReaderKind = 3
	const LogReaderWhenQueue LogReaderKind = 6
	const LogReaderWhenTime LogReaderKind = 4

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.