package history

Import Path
	/pkg/history (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 3 packages

Involved Source Files

	  d history.go
		Package history provides machine history tracking and traversal using
		the process' memory and structs.
Package-Level Type Names (total 14)

	/* sort by: alphabet | popularity */
	 type Backend (struct)
		Backend enumerates all available asyncmachine history backends.

		Fields (only one)
			Value string
		As Types Of (total 3)
			  var BackendBbolt
			  var BackendMemory
			  var BackendSqlite

	 type BaseConfig (struct)
		BaseConfig describes the tracking configuration - conditions, list of tracked
		states and data expiration TTLs.

		Fields (total 10)
			Called am.S
				Called is a list of mutation states (called ones) required to track a
				transition. See also CalledExclude. Optional.

			CalledExclude bool
				CalledExclude flips Called to be a blocklist.

			Changed am.S
				Changed is a list of transition states which had clock changes, required to
				track a transition. See also ChangedExclude. A state can be called, but not
				changed. Optional.

			ChangedExclude bool
				ChangedExclude flips Changed to be a blocklist.

			Log bool
			MaxRecords int
				MaxRecords is the maximum number of records to keep in the history before
				a rotation begins.

			StoreSchema bool
				TODO StoreSchema keeps the latest machine schema and state names within
				[MachineRecord]. Useful for dynamic machines.

			StoreTransitions bool
				StoreTransitions is a flag to store TransitionRecord, in addition to
				TimeRecord, for each tracked transition.

			TrackRejected bool
				TrackRejected is a flag to track rejected transitions.

			TrackedStates am.S
				TrackedStates is a list of states to store clock values of.

		As Outputs Of (at least 5)
			func (*BaseMemory).Config() BaseConfig
			func (*Memory).Config() BaseConfig
			func MemoryApi.Config() BaseConfig
			func github.com/pancsta/asyncmachine-go/pkg/history/bbolt.(*Memory).Config() BaseConfig
			func github.com/pancsta/asyncmachine-go/pkg/history/gorm.(*Memory).Config() BaseConfig
		As Inputs Of (at least 2)
			func NewBaseMemory(ctx context.Context, mach am.Api, config BaseConfig, memImpl MemoryApi) *BaseMemory
			func NewMemory(ctx context.Context, machRecord *MachineRecord, mach am.Api, config BaseConfig, onErr func(err error)) (*Memory, error)

	 type BaseMemory (struct)
		BaseMemory are the common methods for all memory implementations, operating
		on common models, like [TimeRecord] or [Query].

		Fields (total 3)
			Cfg *BaseConfig
				read-only config for this history

			Ctx context.Context
			Mach am.Api
		Methods (total 20)
			(*BaseMemory) ActivatedBetween(ctx context.Context, state string, start, end time.Time) bool
				ActivatedBetween returns true if the state was activated within the passed
				human time range.

			(*BaseMemory) ActiveBetween(ctx context.Context, state string, start, end time.Time) bool
				ActiveBetween returns true if the state was activated all the time within
				the passed human time range.

			(*BaseMemory) Config() BaseConfig
			(*BaseMemory) Context() context.Context
			(*BaseMemory) DeactivatedBetween(ctx context.Context, state string, start, end time.Time) bool
			(*BaseMemory) Dispose() error
			(*BaseMemory) FindLatest(ctx context.Context, retTx bool, limit int, query Query) ([]*MemoryRecord, error)
				FindLatest returns the latest records matching the given conditions, in order
				from the newest to the oldest. If the limit is 0, all records are returned.

			(*BaseMemory) InactiveBetween(ctx context.Context, state string, start, end time.Time) bool
			(*BaseMemory) Index(states am.S) []int
				Index returns the indexes of the given states in the history records, or -1
				if the state is not being tracked.

			(*BaseMemory) Index1(state string) int
				Index1 is [BaseMemory.Index] for a single state.

			(*BaseMemory) IsTracked(states am.S) bool
				IsTracked returns true if the given states are all being tracked by this
				memory instance.

			(*BaseMemory) IsTracked1(state string) bool
				IsTracked1 is IsTracked for a single state.

			(*BaseMemory) Machine() am.Api
			(*BaseMemory) MachineRecord() *MachineRecord
				MachineRecord returns a copy of the history record for the tracked machine.

			(*BaseMemory) Sync() error
			(*BaseMemory) ToMachineRecord(format any) (*MachineRecord, error)
			(*BaseMemory) ToMemoryRecord(format any) (*MemoryRecord, error)
			(*BaseMemory) ToTimeRecord(format any) (*TimeRecord, error)
			(*BaseMemory) ToTransitionRecord(format any) (*TransitionRecord, error)
			(*BaseMemory) ValidateQuery(query Query) error
		Implements (at least 2)
			*BaseMemory : MemoryApi
			*BaseMemory : github.com/polarsignals/frostdb.Sync
		As Outputs Of (at least one exported)
			func NewBaseMemory(ctx context.Context, mach am.Api, config BaseConfig, memImpl MemoryApi) *BaseMemory

	 type ConditionTime (struct)

		Fields (total 9)
			HTime time.Time
				HTime is the human time for a mutation to match.

			MTime am.Time
				MTime is the machine time for a mutation to match.

			MTimeDiff uint64
				MTimeDiff is a machine time difference for this transition, compared to the
				previous transition.

			MTimeRecordDiff uint64
				MTimeRecordDiff is a machine time difference since the previous
				[TimeRecord].

			MTimeStates am.S
				MTimeStates is a set of states for MTime.

			MTimeSum uint64
				MTimeSum is a machine time sum after this transition.

			MTimeTrackedDiff uint64
				MTimeDiff is a machine time difference for this transition for tracked
				states only.

			MTimeTrackedSum uint64
				MTimeSum is a machine time sum after this transition for tracked states
				only.

			MachTick uint32
				MachTick is the machine tick at the time of this transition.


	 type ConditionTx (struct)
		ConditionTx represents a condition for a single transition. Requires
		[BaseConfig.StoreTransitions] to be true.

		Fields (total 17)
			Called am.S
				Called is a set of states that were called in the mutation.

			ExecutedAt uint64
			IsAccepted bool
			IsAuto bool
			IsBroken bool
			IsCheck bool
			Query Query
			Query.Activated am.S
				Activated is a set of states that were activated during the transition.

			Query.Active am.S
				Active is a set of states that were active AFTER the mutation

			Query.Deactivated am.S
				Deactivated is a set of states that were deactivated during the
				transition.

			Query.End ConditionTime
				End is the end of a scalar time condition and requires an equivalent in
				[Query.Start].

			Query.Inactive am.S
				Inactive is a set of states that were inactive AFTER the mutation

			Query.Start ConditionTime
				Start is the beginning of a scalar time condition and requires an
				equivalent in [Query.End].

			QueueLen uint16
			QueuedAt uint64
			SourceMach string
			SourceTx string

	 type Config = BaseConfig (struct)
		Config for the in-process memory.

	 type MachineRecord (struct)

		Fields (total 10)
			FirstTracking time.Time
				first time the machine has been tracked

			LastSync time.Time
				last time a sync has been performed

			LastTracking time.Time
				last time a tracking of this machine has started

			MTime am.Time
				current (total) machine time

			MTimeSum uint64
				sum of the current machine time

			MachId string
				ID of the tracked machine

			MachTick uint32
				current machine start tick

			NextId uint64
				next ID for time records

			Schema am.Schema
			StateNames am.S
		As Outputs Of (at least 10)
			func (*BaseMemory).MachineRecord() *MachineRecord
			func (*BaseMemory).ToMachineRecord(format any) (*MachineRecord, error)
			func (*Memory).MachineRecord() *MachineRecord
			func MemoryApi.MachineRecord() *MachineRecord
			func MemoryApi.ToMachineRecord(format any) (*MachineRecord, error)
			func github.com/pancsta/asyncmachine-go/pkg/history/bbolt.GetMachine(db *bbolt.DB, id string) (*MachineRecord, error)
			func github.com/pancsta/asyncmachine-go/pkg/history/bbolt.ListMachines(db *bbolt.DB) ([]*MachineRecord, error)
			func github.com/pancsta/asyncmachine-go/pkg/history/bbolt.(*Memory).MachineRecord() *MachineRecord
			func github.com/pancsta/asyncmachine-go/pkg/history/gorm.ListMachines(db *gorm.DB) ([]*MachineRecord, error)
			func github.com/pancsta/asyncmachine-go/pkg/history/gorm.(*Memory).MachineRecord() *MachineRecord
		As Inputs Of (at least one exported)
			func NewMemory(ctx context.Context, machRecord *MachineRecord, mach am.Api, config BaseConfig, onErr func(err error)) (*Memory, error)

	 type MatcherFn (func)

		As Inputs Of (at least one exported)
			func (*Memory).Match(ctx context.Context, matcherFn MatcherFn) ([]*MemoryRecord, error)

	 type Memory (struct)

		Fields (total 4)
			BaseMemory *BaseMemory
			BaseMemory.Cfg *BaseConfig
				read-only config for this history

			BaseMemory.Ctx context.Context
			BaseMemory.Mach am.Api
		Methods (total 22)
			( Memory) ActivatedBetween(ctx context.Context, state string, start, end time.Time) bool
				ActivatedBetween returns true if the state was activated within the passed
				human time range.

			( Memory) ActiveBetween(ctx context.Context, state string, start, end time.Time) bool
				ActiveBetween returns true if the state was activated all the time within
				the passed human time range.

			(*Memory) Config() BaseConfig
			( Memory) Context() context.Context
			( Memory) DeactivatedBetween(ctx context.Context, state string, start, end time.Time) bool
			(*Memory) Dispose() error
			(*Memory) Export() []*MemoryRecord
			(*Memory) FindLatest(ctx context.Context, _ bool, limit int, query Query) ([]*MemoryRecord, error)
				FindLatest is [BaseMemory.FindLatest] for in-process memory.

			( Memory) InactiveBetween(ctx context.Context, state string, start, end time.Time) bool
			( Memory) Index(states am.S) []int
				Index returns the indexes of the given states in the history records, or -1
				if the state is not being tracked.

			( Memory) Index1(state string) int
				Index1 is [BaseMemory.Index] for a single state.

			( Memory) IsTracked(states am.S) bool
				IsTracked returns true if the given states are all being tracked by this
				memory instance.

			( Memory) IsTracked1(state string) bool
				IsTracked1 is IsTracked for a single state.

			(*Memory) Machine() am.Api
			(*Memory) MachineRecord() *MachineRecord
			(*Memory) Match(ctx context.Context, matcherFn MatcherFn) ([]*MemoryRecord, error)
				Match returns the first record that matches the MatcherFn.

			( Memory) Sync() error
			( Memory) ToMachineRecord(format any) (*MachineRecord, error)
			( Memory) ToMemoryRecord(format any) (*MemoryRecord, error)
			( Memory) ToTimeRecord(format any) (*TimeRecord, error)
			( Memory) ToTransitionRecord(format any) (*TransitionRecord, error)
			( Memory) ValidateQuery(query Query) error
		Implements (at least 2)
			*Memory : MemoryApi
			 Memory : github.com/polarsignals/frostdb.Sync
		As Outputs Of (at least one exported)
			func NewMemory(ctx context.Context, machRecord *MachineRecord, mach am.Api, config BaseConfig, onErr func(err error)) (*Memory, error)

	 type MemoryApi (interface)

		Methods (total 18)
			( MemoryApi) ActivatedBetween(ctx context.Context, state string, start, end time.Time) bool
				ActivatedBetween returns true if the state become active withing the
				passed conditions.

			( MemoryApi) ActiveBetween(ctx context.Context, state string, start, end time.Time) bool
				ActiveBetween returns true if the state was active at least once
				within the passed conditions. Always true is ActivatedBetween is true.

			( MemoryApi) Config() BaseConfig
			( MemoryApi) Context() context.Context
			( MemoryApi) DeactivatedBetween(ctx context.Context, state string, start, end time.Time) bool
			( MemoryApi) Dispose() error
			( MemoryApi) FindLatest(ctx context.Context, retTx bool, limit int, query Query) ([]*MemoryRecord, error)
			( MemoryApi) InactiveBetween(ctx context.Context, state string, start, end time.Time) bool
			( MemoryApi) Index(states am.S) []int
			( MemoryApi) Index1(state string) int
			( MemoryApi) IsTracked(states am.S) bool
			( MemoryApi) IsTracked1(state string) bool
			( MemoryApi) Machine() am.Api
			( MemoryApi) MachineRecord() *MachineRecord
			( MemoryApi) Sync() error
				Sync synchronizes the batch buffer with the underlying backend, making
				those new records appear in queries. Doesn't guarantee persistence.
				Useful when queries very fresh records.

			( MemoryApi) ToMachineRecord(format any) (*MachineRecord, error)
			( MemoryApi) ToTimeRecord(format any) (*TimeRecord, error)
			( MemoryApi) ToTransitionRecord(format any) (*TransitionRecord, error)
		Implemented By (at least 4)
			*BaseMemory
			*Memory
			*github.com/pancsta/asyncmachine-go/pkg/history/bbolt.Memory
			*github.com/pancsta/asyncmachine-go/pkg/history/gorm.Memory
		Implements (at least one exported)
			 MemoryApi : github.com/polarsignals/frostdb.Sync
		As Inputs Of (at least 3)
			func NewBaseMemory(ctx context.Context, mach am.Api, config BaseConfig, memImpl MemoryApi) *BaseMemory
			func github.com/pancsta/asyncmachine-go/pkg/history/test.AssertBasics(t *testing.T, mem MemoryApi, rounds int)
			func github.com/pancsta/asyncmachine-go/pkg/history/test.AssertGc(t *testing.T, mem MemoryApi, rounds int)

	 type MemoryRecord (struct)

		Fields (total 2)
			Time *TimeRecord
			Transition *TransitionRecord
		As Outputs Of (at least 10)
			func (*BaseMemory).FindLatest(ctx context.Context, retTx bool, limit int, query Query) ([]*MemoryRecord, error)
			func (*BaseMemory).ToMemoryRecord(format any) (*MemoryRecord, error)
			func (*Memory).Export() []*MemoryRecord
			func (*Memory).FindLatest(ctx context.Context, _ bool, limit int, query Query) ([]*MemoryRecord, error)
			func (*Memory).Match(ctx context.Context, matcherFn MatcherFn) ([]*MemoryRecord, error)
			func MemoryApi.FindLatest(ctx context.Context, retTx bool, limit int, query Query) ([]*MemoryRecord, error)
			func github.com/pancsta/asyncmachine-go/pkg/history/bbolt.(*Memory).FindLatest(ctx context.Context, retTx bool, limit int, query Query) ([]*MemoryRecord, error)
			func github.com/pancsta/asyncmachine-go/pkg/history/bbolt.(*Memory).Match(ctx context.Context, matcherFn bbolt.MatcherFn) ([]*MemoryRecord, error)
			func github.com/pancsta/asyncmachine-go/pkg/history/gorm.(*Memory).FindLatest(ctx context.Context, retTx bool, limit int, query Query) ([]*MemoryRecord, error)
			func github.com/pancsta/asyncmachine-go/pkg/history/gorm.(*Memory).Match(ctx context.Context, limit int, matcherFn gorm.MatcherFn) ([]*MemoryRecord, error)

	 type Query (struct)
		Query represents various conditions for a single mutation. All are
		optional, but at least one must be set.

		Fields (total 6)
			Activated am.S
				Activated is a set of states that were activated during the transition.

			Active am.S
				Active is a set of states that were active AFTER the mutation

			Deactivated am.S
				Deactivated is a set of states that were deactivated during the
				transition.

			End ConditionTime
				End is the end of a scalar time condition and requires an equivalent in
				[Query.Start].

			Inactive am.S
				Inactive is a set of states that were inactive AFTER the mutation

			Start ConditionTime
				Start is the beginning of a scalar time condition and requires an
				equivalent in [Query.End].

		As Inputs Of (at least 6)
			func (*BaseMemory).FindLatest(ctx context.Context, retTx bool, limit int, query Query) ([]*MemoryRecord, error)
			func (*BaseMemory).ValidateQuery(query Query) error
			func (*Memory).FindLatest(ctx context.Context, _ bool, limit int, query Query) ([]*MemoryRecord, error)
			func MemoryApi.FindLatest(ctx context.Context, retTx bool, limit int, query Query) ([]*MemoryRecord, error)
			func github.com/pancsta/asyncmachine-go/pkg/history/bbolt.(*Memory).FindLatest(ctx context.Context, retTx bool, limit int, query Query) ([]*MemoryRecord, error)
			func github.com/pancsta/asyncmachine-go/pkg/history/gorm.(*Memory).FindLatest(ctx context.Context, retTx bool, limit int, query Query) ([]*MemoryRecord, error)

	 type TimeRecord (struct)

		Fields (total 10)
			HTime time.Time
				HTime is a human time in UTC.

			MTimeDiffSum uint64
				MTimeDiffSum is a machine time difference for this transition.

			MTimeRecordDiffSum uint64
				MTimeRecordDiffSum is a machine time difference since the previous
				[TimeRecord].

			MTimeSum uint64
				MTimeSum is a machine time sum after this transition.

			MTimeTracked am.Time
				MTime is a machine time after this mutation.

			MTimeTrackedDiff am.Time
				MTimeTrackedDiff is a machine time diff compared to the previous mutation
				(not a record).

			MTimeTrackedDiffSum uint64
				MTimeDiffSum is a machine time difference for this transition for tracked
				states only.

			MTimeTrackedSum uint64
				MTimeSum is a machine time sum after this transition for tracked states
				only.

			MachTick uint32
				MachTick is the machine tick at the time of this transition.

			MutType am.MutationType
				MutType is a mutation type.

		As Outputs Of (at least 3)
			func (*BaseMemory).ToTimeRecord(format any) (*TimeRecord, error)
			func MemoryApi.ToTimeRecord(format any) (*TimeRecord, error)
			func github.com/pancsta/asyncmachine-go/pkg/history/bbolt.DecTimeRecord(machId string, id uint64, v []byte, tryJson bool) (*TimeRecord, error)

	 type TransitionRecord (struct)

		Fields (total 13)
			Arguments map[string]string
			Called []int
				extra

			ExecutedAt uint64
			IsAccepted bool
			IsAuto bool
			IsBroken bool
			IsCheck bool
			QueueLen uint16
			QueuedAt uint64
			SourceMach string
			SourceTx string
			TimeRecordId uint64
			TransitionId string
		As Outputs Of (at least 3)
			func (*BaseMemory).ToTransitionRecord(format any) (*TransitionRecord, error)
			func MemoryApi.ToTransitionRecord(format any) (*TransitionRecord, error)
			func github.com/pancsta/asyncmachine-go/pkg/history/bbolt.DecTransitionRecord(machId string, id uint64, v []byte, tryJson bool) (*TransitionRecord, error)


Package-Level Functions (total 2)

	 func NewBaseMemory(ctx context.Context, mach am.Api, config BaseConfig, memImpl MemoryApi) *BaseMemory
	 func NewMemory(ctx context.Context, machRecord *MachineRecord, mach am.Api, config BaseConfig, onErr func(err error)) (*Memory, error)
		NewMemory returns a new memory instance that tracks the given machine
		according to the given tracking configuration. All states are tracked by
		default, which often is not desired. Keeps 1000 records by default.


Package-Level Variables (total 7)

	  var BackendBbolt Backend
	  var BackendEnum enum.Enum[...]
	  var BackendMemory Backend
	  var BackendSqlite Backend
	  var ErrCondition error
	  var ErrConfig error
		TODO bind ErrConfig

	  var ErrIncompatibleType error

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.