FSM

type ActiveFSM ¶

type ActiveFSM[I any, S any, E uc.Enumer] struct {

	// Tray is the tray that the FSM uses to store data.
	Tray ut.Trayer[I]
	// contains filtered or unexported fields
}

ActiveFSM is a struct that represents an active finite state machine.

func (a *ActiveFSM[I, S, E]) GetState() S

func (a *ActiveFSM[I, S, E]) GetValue(key E) (any, bool)

type DetFunc ¶

type DetFunc[I any, S any, E uc.Enumer] func(fsm *ActiveFSM[I, S, E]) (any, error)

DetFunc is a function that determines the value of an element of the FSM.

Parameters:

• fsm: The active FSM.

Returns:

• any: The value of the element.
• error: An error if the function fails.

type EndCond ¶

type EndCond[I any, S any, E uc.Enumer] func(fsm *ActiveFSM[I, S, E]) bool

EndCond is a function that determines whether the FSM should end.

Parameters:

• fsm: The active FSM.

Returns:

• bool: A boolean indicating whether the FSM should end.

type EvalFunc ¶

type EvalFunc[I any, S any, R any, E uc.Enumer] func(fsm *ActiveFSM[I, S, E]) (R, error)

EvalFunc is a function that evaluates the FSM.

Parameters:

• fsm: The active FSM.

Returns:

• any: The result of the evaluation.
• error: An error if the function fails.

type FSM ¶

type FSM[I any, S any, R any, E uc.Enumer] struct {
	// InitFn is the function that initializes the FSM.
	InitFn InitFunc[I, S]

	// ShouldEndFn is the function that determines whether the FSM should end.
	ShouldEndFn EndCond[I, S, E]

	// GetResFn is the function that retrieves the result of the FSM.
	GetResFn EvalFunc[I, S, R, E]

	// NextFn is the function that transitions the FSM to the next state.
	NextFn TransFunc[I, S, E]
	// contains filtered or unexported fields
}

FSM is a struct that represents a finite state machine.

func (fsm *FSM[I, S, R, E]) Run(inputStream ut.Trayable[I]) ([]R, error)

type FsmBuilder ¶

type FsmBuilder[I any, S any, R any, E uc.Enumer] struct {
	// InitFn is the function that initializes the FSM.
	InitFn InitFunc[I, S]

	// ShouldEndFn is the function that determines whether the FSM should end.
	ShouldEndFn EndCond[I, S, E]

	// GetResFn is the function that retrieves the result of the FSM.
	GetResFn EvalFunc[I, S, R, E]

	// NextFn is the function that transitions the FSM to the next state.
	NextFn TransFunc[I, S, E]
	// contains filtered or unexported fields
}

FsmBuilder is a struct that represents a builder for a finite state machine.

func (b *FsmBuilder[I, S, R, E]) AddDetFn(elem E, fn DetFunc[I, S, E])

func (b *FsmBuilder[I, S, R, E]) Build() (*FSM[I, S, R, E], error)

type InitFunc ¶

type InitFunc[I any, S any] func(tray ut.Trayer[I]) (S, error)

InitFunc is a function that initializes the FSM.

Parameters:

• tray: The tray that the FSM uses to store data.

Returns:

• S: The initial state of the FSM.
• error: An error if the function fails.

type TransFunc ¶

type TransFunc[I any, S any, E uc.Enumer] func(fsm *ActiveFSM[I, S, E]) (S, error)

TransFunc is a function that transitions the FSM to the next state.

Parameters:

• fsm: The active FSM.

Returns:

• S: The next state of the FSM.
• error: An error if the function fails.