Skip to main content

HookRegistry

Struct HookRegistry 

Source
pub struct HookRegistry { /* private fields */ }
Expand description

Registry of async hook handlers. Cheap to clone.

Implementations§

Source§

impl HookRegistry

Source

pub fn new() -> Self

An empty registry.

Source

pub fn on<F, Fut>( &mut self, event: HookEventKind, matcher: Option<&str>, handler: F, ) -> &mut Self
where F: Fn(HookEventPayload) -> Fut + Send + Sync + 'static, Fut: Future<Output = HookOutput> + Send + 'static,

Register an async closure for a hook event.

matcher filters by tool name for tool events (regex, e.g. "Bash|Edit"); None matches everything.

let mut hooks = HookRegistry::new();
hooks.on(HookEventKind::PreToolUse, Some("Bash"), |payload| async move {
    HookOutput::block("Bash is disabled")
});
Source

pub fn on_with_timeout<F, Fut>( &mut self, event: HookEventKind, matcher: Option<&str>, timeout_s: Option<u32>, handler: F, ) -> &mut Self
where F: Fn(HookEventPayload) -> Fut + Send + Sync + 'static, Fut: Future<Output = HookOutput> + Send + 'static,

Same as on, with a per-hook timeout in seconds enforced by the CLI.

Source

pub fn on_pre_tool_use<F, Fut>(&mut self, f: F) -> &mut Self
where F: Fn(HookEventPayload) -> Fut + Send + Sync + 'static, Fut: Future<Output = HookOutput> + Send + 'static,

on(PreToolUse, None, f): runs before every tool call.

Source

pub fn on_stop<F, Fut>(&mut self, f: F) -> &mut Self
where F: Fn(HookEventPayload) -> Fut + Send + Sync + 'static, Fut: Future<Output = HookOutput> + Send + 'static,

on(Stop, None, f).

Source

pub fn on_user_prompt_submit<F, Fut>(&mut self, f: F) -> &mut Self
where F: Fn(HookEventPayload) -> Fut + Send + Sync + 'static, Fut: Future<Output = HookOutput> + Send + 'static,

on(UserPromptSubmit, None, f).

Source

pub fn is_empty(&self) -> bool

Whether no hook is registered.

Source

pub fn initialize_config( &self, ) -> Option<HashMap<HookEventKind, Vec<HookMatcherConfig>>>

The hooks field of the initialize request.

Source

pub async fn dispatch( &self, callback_id: &str, payload: HookEventPayload, ) -> Option<HookOutput>

Run the handler registered under callback_id. Returns None when the id is unknown.

Trait Implementations§

Source§

impl Clone for HookRegistry

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for HookRegistry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HookRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more