Skip to main content

HookRegistry

Struct HookRegistry 

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

Registry of lifecycle hooks with typed registration and timeout enforcement.

Implementations§

Source§

impl HookRegistry

Source

pub fn new() -> Self

Create an empty registry.

Source

pub fn on_pre_tool_use<F>(&mut self, matcher: HookMatcher, f: F)
where F: Fn(PreToolUseContext) -> BoxFuture<'static, HookResult> + Send + Sync + 'static,

Register a pre-tool-use hook.

Source

pub fn on_post_tool_use<F>(&mut self, matcher: HookMatcher, f: F)
where F: Fn(PostToolUseContext) -> BoxFuture<'static, HookResult> + Send + Sync + 'static,

Register a post-tool-use hook.

Source

pub fn on_post_tool_use_failure<F>(&mut self, matcher: HookMatcher, f: F)
where F: Fn(PostToolUseFailureContext) -> BoxFuture<'static, HookResult> + Send + Sync + 'static,

Register a post-tool-use failure hook.

Source

pub fn on_notification<F>(&mut self, matcher: HookMatcher, f: F)
where F: Fn(NotificationContext) -> BoxFuture<'static, HookResult> + Send + Sync + 'static,

Register a notification hook.

Source

pub fn on_subagent_start<F>(&mut self, matcher: HookMatcher, f: F)
where F: Fn(SubagentStartContext) -> BoxFuture<'static, HookResult> + Send + Sync + 'static,

Register a subagent start hook.

Source

pub fn on_subagent_stop<F>(&mut self, matcher: HookMatcher, f: F)
where F: Fn(SubagentStopContext) -> BoxFuture<'static, HookResult> + Send + Sync + 'static,

Register a subagent stop hook.

Source

pub fn on_pre_compact<F>(&mut self, matcher: HookMatcher, f: F)
where F: Fn(PreCompactContext) -> BoxFuture<'static, HookResult> + Send + Sync + 'static,

Register a pre-compact hook.

Source

pub fn on_post_compact<F>(&mut self, matcher: HookMatcher, f: F)
where F: Fn(PostCompactContext) -> BoxFuture<'static, HookResult> + Send + Sync + 'static,

Register a post-compact hook.

Source

pub fn on_session_start<F>(&mut self, matcher: HookMatcher, f: F)
where F: Fn(SessionStartContext) -> BoxFuture<'static, HookResult> + Send + Sync + 'static,

Register a session start hook.

Source

pub fn on_session_end<F>(&mut self, matcher: HookMatcher, f: F)
where F: Fn(SessionEndContext) -> BoxFuture<'static, HookResult> + Send + Sync + 'static,

Register a session end hook.

Source

pub async fn run_pre_tool_use( &self, ctx: PreToolUseContext, ) -> Result<HookResult, AgentError>

Run all matching pre-tool-use hooks in registration order.

Returns the first Abort result encountered, or Continue if all pass. Hooks that exceed their timeout are skipped with a warn! log.

Source

pub async fn run_post_tool_use( &self, ctx: PostToolUseContext, ) -> Result<HookResult, AgentError>

Run all matching post-tool-use hooks.

Source

pub async fn run_post_tool_use_failure( &self, ctx: PostToolUseFailureContext, ) -> Result<HookResult, AgentError>

Run all matching post-tool-use failure hooks.

Source

pub async fn run_notification( &self, ctx: NotificationContext, ) -> Result<HookResult, AgentError>

Run all notification hooks.

Source

pub async fn run_session_start( &self, ctx: SessionStartContext, ) -> Result<HookResult, AgentError>

Run all session start hooks.

Source

pub async fn run_session_end( &self, ctx: SessionEndContext, ) -> Result<HookResult, AgentError>

Run all session end hooks.

Source

pub async fn run_subagent_start( &self, ctx: SubagentStartContext, ) -> Result<HookResult, AgentError>

Run all subagent start hooks.

Source

pub async fn run_subagent_stop( &self, ctx: SubagentStopContext, ) -> Result<HookResult, AgentError>

Run all subagent stop hooks.

Source

pub async fn run_pre_compact( &self, ctx: PreCompactContext, ) -> Result<HookResult, AgentError>

Run all pre-compact hooks.

Source

pub async fn run_post_compact( &self, ctx: PostCompactContext, ) -> Result<HookResult, AgentError>

Run all post-compact hooks.

Trait Implementations§

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() -> HookRegistry

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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