Skip to main content

HooksSet

Struct HooksSet 

Source
pub struct HooksSet(/* private fields */);
Expand description

Ordered set of hook implementations run at every hook point.

Adding a hook is just pushing another Hooks impl: transform_* and after_tool_call run for every hook in order, before_tool_call and should_stop_after_turn short-circuit on the first hit. An empty set is the default (every hook method is a no-op), so an agent without extra hooks typically passes HooksSet::default().

Implementations§

Source§

impl HooksSet

Source

pub fn new() -> Self

Source

pub fn one(hook: Arc<dyn Hooks>) -> Self

A set with a single hook — the common case for one integration (e.g. HooksSet::one(Arc::new(RtkHooks::new(rtk)))).

Source

pub fn push(&mut self, hook: Arc<dyn Hooks>)

Source

pub fn is_empty(&self) -> bool

Source

pub async fn transform_tool_input(&self, call: &mut ToolCall)

Source

pub async fn before_tool_call(&self, call: &ToolCall) -> Option<String>

First Some(reason) wins: a blocking hook prevents execution entirely (and therefore any later after_tool_call).

Source

pub async fn before_inbound( &self, from: Option<&SessionId>, request: &mut Request, ) -> Option<String>

First Some(reason) wins: a dropping hook prevents delivery (the request is not serviced). request may have been rewritten in place by earlier hooks — the rewrite is what would be delivered.

Source

pub async fn after_tool_call(&self, call: &ToolCall, out: &mut ToolOutput)

Source

pub async fn transform_context(&self, msgs: &mut Vec<AgentMessage>)

Source

pub async fn should_stop_after_turn(&self, ctx: &[AgentMessage]) -> bool

true ends the run; evaluated after the tool loop completes.

Source

pub async fn after_run(&self, ctx: &[AgentMessage], stop: StopReason)

Runs every hook’s after_run in order, once per run.

Trait Implementations§

Source§

impl Clone for HooksSet

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 Default for HooksSet

Source§

fn default() -> Self

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

impl FromIterator<Arc<dyn Hooks>> for HooksSet

Source§

fn from_iter<T: IntoIterator<Item = Arc<dyn Hooks>>>(iter: T) -> Self

Creates a value from an iterator. 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> 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> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

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
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