Skip to main content

Module hooks

Module hooks 

Source
Expand description

Lifecycle hook runtime contracts and orchestration primitives.

Structs§

HookDefaults
Hook defaults applied when a hook spec omits optional limits.
HookEngine
Resolves configured hooks for a lifecycle phase-event.
HookExecutor
Default hook executor implementation.
HookInvocationPayload
Structured lifecycle payload sent to hook stdin as JSON.
HookMutationConfig
Mutation settings for a hook.
HookPayloadBuilderInput
Input contract for building hook invocation stdin payloads.
HookPayloadContext
Lifecycle context payload block.
HookPayloadContextInput
Mutable lifecycle context fields carried in hook stdin payloads.
HookPayloadIteration
Iteration metadata payload block.
HookPayloadLoop
Loop metadata payload block.
HookPayloadMetadata
Mutable metadata payload block.
HookRunRequest
Input contract for executing a single lifecycle hook command.
HookRunResult
Structured outcome for one hook invocation.
HookSpec
Hook specification for a single lifecycle event mapping.
HookStreamOutput
Captured hook stream output with truncation metadata.
HooksConfig
Hooks configuration.
ResolvedHookSpec
Hook spec with defaults materialized for runtime dispatch.
SuspendStateRecord
Durable suspend-state payload written when a hook yields on_error: suspend.
SuspendStateStore
File-store for suspend/resume artifacts under a loop workspace.

Enums§

HookExecutorError
Hook executor errors.
HookOnError
Per-hook failure disposition.
HookPhaseEvent
Supported lifecycle phase-event keys for v1 hooks.
HookSuspendMode
Suspend mode used for on_error: suspend.
SuspendLifecycleState
Runtime lifecycle state persisted in .ralph/suspend-state.json.
SuspendStateStoreError
Suspend-state store operations that can fail.

Constants§

SUSPEND_STATE_SCHEMA_VERSION
Current suspend-state schema version.

Traits§

HookExecutorContract
Contract for executing one hook run request.