Skip to main content

HookRegistry

Struct HookRegistry 

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

A registry of hooks keyed by event type.

Wraps a HashMap<HookEvent, Vec<HookCallbackMatcher>> and provides methods to run hooks for specific events.

§Example

use starpod_hooks::{HookRegistry, HookEvent, HookCallbackMatcher, hook_fn, HookOutput};

let mut registry = HookRegistry::new();
registry.register(HookEvent::PostToolUse, vec![
    HookCallbackMatcher::new(vec![
        hook_fn(|_input, _id, _cancel| async move {
            Ok(HookOutput::default())
        }),
    ]).with_matcher("Bash"),
]);

assert!(registry.has_hooks(&HookEvent::PostToolUse));
assert!(!registry.has_hooks(&HookEvent::PreToolUse));

Implementations§

Source§

impl HookRegistry

Source

pub fn new() -> HookRegistry

Source

pub fn from_map( hooks: HashMap<HookEvent, Vec<HookCallbackMatcher>>, ) -> HookRegistry

Create a registry from an existing HashMap.

Source

pub fn with_circuit_breaker(self, config: CircuitBreakerConfig) -> HookRegistry

Set a custom circuit breaker configuration.

Source

pub fn register(&mut self, event: HookEvent, matchers: Vec<HookCallbackMatcher>)

Register matchers for a hook event.

Source

pub fn has_hooks(&self, event: &HookEvent) -> bool

Check if any hooks are registered for the given event.

Source

pub fn get(&self, event: &HookEvent) -> Option<&Vec<HookCallbackMatcher>>

Get the matchers for a given event.

Source

pub fn into_map(self) -> HashMap<HookEvent, Vec<HookCallbackMatcher>>

Consume the registry and return the inner HashMap.

Source

pub fn merge(&mut self, other: HookRegistry)

Merge another registry’s hooks into this one.

Source

pub async fn run_post_tool_use( &self, tool_name: &str, tool_input: &Value, tool_response: &Value, tool_use_id: &str, session_id: &str, cwd: &str, )

Run all matching hooks for PostToolUse.

Hooks are fire-and-forget: errors are logged but do not propagate.

Source

pub async fn run_pre_tool_use( &self, tool_name: &str, tool_input: &Value, tool_use_id: &str, session_id: &str, cwd: &str, ) -> Option<HookOutput>

Run all matching hooks for PreToolUse.

Returns the merged HookOutput from all matching hooks, or None if no hooks matched.

Source

pub async fn run_event(&self, event: &HookEvent, input: HookInput)

Run hooks for a generic (non-tool) event.

Fires all registered hooks for the event. Errors are logged.

Trait Implementations§

Source§

impl Debug for HookRegistry

Source§

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

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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