module

type AfterCompileHook func(ctx context.Context, err error) error

type AfterRunHook func(ctx context.Context, err error) error

type BeforeCompileHook func(ctx context.Context) error

type BeforeRunHook func(ctx context.Context) (context.Context, error)

type Bootstrap interface {
	// Host returns the host-scoped registries and services that a module can
	// populate during engine construction.
	Host() HostContext
	// Hooks returns the lifecycle hook registrars for the engine, plan, and
	// session stages created from this engine.
	Hooks() HookRegistrar
}

type EngineCloseHook func() error

type EngineHookRegistrar interface {
	// OnInit registers a hook executed in FIFO order during engine
	// initialization.
	// A nil hook is ignored.
	OnInit(hook EngineInitHook)
	// OnClose registers a hook executed in LIFO order when engine
	// construction fails or the engine is closed.
	// A nil hook is ignored.
	OnClose(hook EngineCloseHook)
}

type EngineInitHook func() error

type HookRegistrar interface {
	// Engine returns the registrar for engine initialization and shutdown
	// hooks.
	Engine() EngineHookRegistrar
	// Plan returns the registrar for plan compilation and shutdown hooks.
	Plan() PlanHookRegistrar
	// Session returns the registrar for session run and shutdown hooks.
	Session() SessionHookRegistrar
}

type HostContext interface {
	// Library returns the runtime library registry being assembled for the
	// engine.
	Library() runtime.Library
	// Params returns the default parameter set inherited by sessions created
	// from the engine.
	Params() runtime.Params
	// Encoding returns the codec registrar used to configure output encoding for
	// the engine.
	Encoding() encoding.CodecRegistrar
	// Logger returns the engine logger used by the engine and inherited by
	// sessions created from it.
	Logger() logging.Logger
	// FileSystem returns the file system used by the engine and derived
	// executions.
	FileSystem() fs.FileSystem
}

type Module interface {
	// Name returns the stable identifier for this module.
	Name() string
	// Register mutates the engine bootstrap state for this module instance.
	// Returning an error aborts engine construction.
	Register(Bootstrap) error
}

type PlanCloseHook func() error

type PlanHookRegistrar interface {
	// BeforeCompile registers a hook executed in FIFO order before plan
	// compilation starts.
	// A nil hook is ignored.
	BeforeCompile(hook BeforeCompileHook)
	// AfterCompile registers a hook executed in LIFO order after each
	// compilation attempt.
	// It receives the compilation error (if any), and a nil hook is ignored.
	AfterCompile(hook AfterCompileHook)
	// OnClose registers a hook executed in LIFO order when a compiled plan is
	// closed.
	// A nil hook is ignored.
	OnClose(hook PlanCloseHook)
}

type SessionCloseHook func() error

type SessionHookRegistrar interface {
	// BeforeRun registers a hook executed in FIFO order before each session
	// run.
	// Hooks can replace the context passed to subsequent hooks and VM execution.
	// A nil hook is ignored.
	BeforeRun(hook BeforeRunHook)
	// AfterRun registers a hook executed in LIFO order after each session run
	// attempt.
	// It receives the run error (if any), and a nil hook is ignored.
	AfterRun(hook AfterRunHook)
	// OnClose registers a hook executed in LIFO order when a session is
	// closed.
	// A nil hook is ignored.
	OnClose(hook SessionCloseHook)
}