Struct HooksBuilder 

pub struct HooksBuilder {
    inner: Hooks,
}

Builder for Hooks.

Fields

inner: Hooks

Implementations

impl HooksBuilder

pub fn new() -> Self

Start empty.

pub fn default_timeout_secs(self, secs: u64) -> Self

Override the per-hook timeout (seconds) emitted in the initialize control_request. The CLI uses this to decide how long to wait on each hook_callback reply before giving up and emitting a control_cancel_request. Default when unset is 120 seconds. Lower it for scenarios that deliberately provoke cancellation; raise it for long-running callbacks (e.g. LLM sub-calls inside a hook).

pub fn pre_tool_use<C>(self, matcher: impl Into<String>, callback: C) -> Self

where C: HookCallback<PreToolUseInput> + 'static,

Register a PreToolUse hook. matcher is a glob against tool names ("*" matches all); pass "Bash" to match only the Bash tool.

pub fn post_tool_use<C>(self, matcher: impl Into<String>, callback: C) -> Self

where C: HookCallback<PostToolUseInput> + 'static,

Register a PostToolUse hook.

pub fn user_prompt_submit<C>(self, callback: C) -> Self

where C: HookCallback<UserPromptSubmitInput> + 'static,

Register a UserPromptSubmit hook.

pub fn stop<C>(self, callback: C) -> Self

where C: HookCallback<StopInput> + 'static,

Register a Stop hook.

pub fn subagent_stop<C>(self, callback: C) -> Self

where C: HookCallback<SubagentStopInput> + 'static,

Register a SubagentStop hook.

pub fn pre_compact<C>(self, callback: C) -> Self

where C: HookCallback<PreCompactInput> + 'static,

Register a PreCompact hook.

pub fn post_tool_use_failure<C>( self, matcher: impl Into<String>, callback: C, ) -> Self

where C: HookCallback<PostToolUseFailureInput> + 'static,

Register a PostToolUseFailure hook. matcher follows the same tool-name glob semantics as Self::pre_tool_use / Self::post_tool_use.

pub fn notification<C>(self, callback: C) -> Self

where C: HookCallback<NotificationInput> + 'static,

Register a Notification hook.

pub fn subagent_start<C>(self, callback: C) -> Self

where C: HookCallback<SubagentStartInput> + 'static,

Register a SubagentStart hook.

pub fn permission_request<C>( self, matcher: impl Into<String>, callback: C, ) -> Self

where C: HookCallback<PermissionRequestInput> + 'static,

Register a PermissionRequest hook (observational; matcher globs against tool names the same way as Self::pre_tool_use).

pub fn build(self) -> Hooks

Finalise.

Trait Implementations

impl Debug for HooksBuilder

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

Formats the value using the given formatter.

impl Default for HooksBuilder

fn default() -> Self

Returns the “default value” for a type.