Enum HookEvent 

#[non_exhaustive]
pub enum HookEvent<'a> {
    TurnStart {
        turn_id: TurnId,
    },
    OnSystemPromptBuilt {
        prompt: &'a str,
    },
    BeforeProviderCall {
        messages: &'a [Message],
    },
    AfterProviderCall {
        tokens_in: u32,
        tokens_out: u32,
    },
    OnTextDelta {
        text: &'a str,
    },
    OnToolCallProposed {
        call: &'a ToolCall,
    },
    BeforeToolBatch {
        calls: &'a [ToolCall],
    },
    BeforePermissionCheck {
        call: &'a ToolCall,
    },
    AfterPermissionCheck {
        call: &'a ToolCall,
        decision: PermissionDecision,
    },
    BeforeBashSandboxExec {
        command: &'a str,
    },
    AfterBashSandboxExec {
        exit: i32,
        duration: Duration,
    },
    BeforeToolCall {
        call: &'a ToolCall,
    },
    AfterToolCall {
        call: &'a ToolCall,
        result: &'a ToolResult,
    },
    OnToolResultObserved {
        observation: &'a ToolObservation,
    },
    AfterToolBatch {
        results: &'a [ToolResult],
    },
    OnDoomLoopDetected {
        signature: &'a str,
    },
    OnBudgetExceeded {
        kind: BudgetKind,
        used: u64,
        limit: u64,
    },
    OnProviderError {
        error: &'a ProviderError,
    },
    OnTurnEnd {
        reason: TurnEndReason,
    },
    TurnComplete {
        turn_id: TurnId,
        status: TurnStatus,
    },
}

A lifecycle event emitted by the Talos runtime.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

TurnStart

The turn has started.

Fields

turn_id: TurnId

Current turn identifier.

OnSystemPromptBuilt

The system prompt has been assembled.

Fields

prompt: &'a str

Final prompt text.

BeforeProviderCall

Immediately before invoking the provider.

Fields

messages: &'a [Message]

Messages sent to the provider.

AfterProviderCall

After the provider stream has completed.

Fields

tokens_in: u32

Input tokens consumed.

tokens_out: u32

Output tokens produced.

OnTextDelta

A text delta was observed.

Fields

text: &'a str

Delta text.

OnToolCallProposed

A tool call was proposed by the model.

Fields

call: &'a ToolCall

Proposed tool call.

BeforeToolBatch

Immediately before executing a batch of tool calls.

Fields

calls: &'a [ToolCall]

Tool calls to execute.

BeforePermissionCheck

Immediately before evaluating permissions for a tool call.

Fields

call: &'a ToolCall

Tool call being evaluated.

AfterPermissionCheck

Immediately after evaluating permissions for a tool call.

Fields

call: &'a ToolCall

Tool call being evaluated.

decision: PermissionDecision

Permission decision returned by the engine.

BeforeBashSandboxExec

Immediately before executing a bash command in the sandbox.

Fields

command: &'a str

Bash command string.

AfterBashSandboxExec

Immediately after sandboxed bash execution completes.

Fields

exit: i32

Process exit code.

duration: Duration

Total execution duration.

BeforeToolCall

Immediately before invoking a tool.

Fields

call: &'a ToolCall

Tool call being executed.

AfterToolCall

Immediately after invoking a tool.

Fields

call: &'a ToolCall

Tool call that was executed.

result: &'a ToolResult

Tool result returned by the tool.

OnToolResultObserved

A tool result was observed and added back into the conversation.

Fields

observation: &'a ToolObservation

Owned observation payload.

AfterToolBatch

After a batch of tool calls has completed.

Fields

results: &'a [ToolResult]

Tool results in input order.

OnDoomLoopDetected

Doom-loop detection fired.

Fields

signature: &'a str

Doom-loop signature string.

OnBudgetExceeded

A runtime budget was exceeded.

Fields

kind: BudgetKind

Budget category.

used: u64

Amount used.

limit: u64

Configured limit.

OnProviderError

A provider error occurred.

Fields

error: &'a ProviderError

Provider error instance.

OnTurnEnd

The provider signaled turn end.

Fields

reason: TurnEndReason

Turn-end reason.

TurnComplete

The turn completed.

Fields

turn_id: TurnId

Current turn identifier.

status: TurnStatus

Final turn status.

Implementations

impl HookEvent<'_>

pub fn kind(&self) -> HookEventKind

Returns the discriminant used for subscription and pre-filtering.

pub fn is_permission_boundary(&self) -> bool

Returns whether this event is inside the permission read-only boundary.

Trait Implementations

impl<'a> Debug for HookEvent<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.