package bbolt

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

Dependency Relation
	imports 15 packages, and imported by 0 packages

Involved Source Files

	  d bbolt.go
		Package bbolt provides machine history tracking and traversal using
		the bbolt K/V database.
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Config (struct)

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

			BaseConfig.CalledExclude bool
				CalledExclude flips Called to be a blocklist.

			BaseConfig.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.

			BaseConfig.ChangedExclude bool
				ChangedExclude flips Changed to be a blocklist.

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

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

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

			BaseConfig.TrackRejected bool
				TrackRejected is a flag to track rejected transitions.

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

			EncJson bool
			QueueBatch int32
				amount of records to save in bulk (default: 100)

		As Inputs Of (at least one exported)
			func NewMemory(ctx context.Context, db *bbolt.DB, mach am.Api, cfg Config, onErr func(err error)) (*Memory, error)

	 type MatcherFn (func)

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

	 type Memory (struct)

		Fields (total 9)
			BaseMemory *amhist.BaseMemory
			BaseMemory.Ctx context.Context
			BaseMemory.Mach am.Api
			Cfg *Config
				read-only config for this history

			Db *bbolt.DB
			SaveInProgress atomic.Bool
			SavePending atomic.Int32
			Saved atomic.Uint64
			SavedGc atomic.Uint64
				Value of Saved at the end of the last GC

		Methods (total 21)
			( 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() amhist.BaseConfig
				Config is [amhist.BaseMemory.Config].

			( Memory) Context() context.Context
			( Memory) DeactivatedBetween(ctx context.Context, state string, start, end time.Time) bool
			(*Memory) Dispose() error
				Dispose is [amhist.BaseMemory.Dispose]. TODO merge with ctx

			(*Memory) FindLatest(ctx context.Context, retTx bool, limit int, query amhist.Query) ([]*amhist.MemoryRecord, error)
				FindLatest is [amhist.BaseMemory.FindLatest].

			( 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
				Machine is [amhist.BaseMemory.Machine].

			(*Memory) MachineRecord() *amhist.MachineRecord
				MachineRecord is [amhist.BaseMemory.MachineRecord].

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

			(*Memory) Sync() error
				Sync is [amhist.BaseMemory.Sync].

			( Memory) ToMachineRecord(format any) (*history.MachineRecord, error)
			( Memory) ToMemoryRecord(format any) (*history.MemoryRecord, error)
			( Memory) ToTimeRecord(format any) (*history.TimeRecord, error)
			( Memory) ToTransitionRecord(format any) (*history.TransitionRecord, error)
			( Memory) ValidateQuery(query history.Query) error
		Implements (at least 2)
			*Memory : github.com/pancsta/asyncmachine-go/pkg/history.MemoryApi
			*Memory : github.com/polarsignals/frostdb.Sync
		As Outputs Of (at least one exported)
			func NewMemory(ctx context.Context, db *bbolt.DB, mach am.Api, cfg Config, onErr func(err error)) (*Memory, error)


Package-Level Functions (total 7)

	 func Decode(v []byte, out any, tryJson bool) error
	 func DecTimeRecord(machId string, id uint64, v []byte, tryJson bool) (*amhist.TimeRecord, error)
	 func DecTransitionRecord(machId string, id uint64, v []byte, tryJson bool) (*amhist.TransitionRecord, error)
	 func GetMachine(db *bbolt.DB, id string) (*amhist.MachineRecord, error)
		GetMachine returns a machine record for a given machine id.

	 func ListMachines(db *bbolt.DB) ([]*amhist.MachineRecord, error)
		ListMachines returns a list of all machines in a database.

	 func NewDb(name string) (*bbolt.DB, error)
	 func NewMemory(ctx context.Context, db *bbolt.DB, mach am.Api, cfg Config, onErr func(err error)) (*Memory, error)
Package-Level Constants (total 3)

	const BuckMachines = "_machines"
	const BuckTimes = "times"
	const BuckTransitions = "transitions"

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.