Skip to main content

Hooks

ferrin_core::hooks

Struct Hooks

pub struct Hooks {
    pub on_start: HookList<StartEvent>,
    pub on_step_start: HookList<StepStartEvent>,
    pub on_language_model_call_start: HookList<ModelCallStartEvent>,
    pub on_language_model_call_end: HookList<ModelCallEndEvent>,
    pub on_tool_execution_start: HookList<ToolExecutionStartEvent>,
    pub on_tool_execution_end: HookList<ToolExecutionEndEvent>,
    pub on_step_end: HookList<StepResult>,
    pub on_end: HookList<EndEvent>,
    pub on_chunk: HookList<StreamEvent>,
    pub on_abort: HookList<AbortEvent>,
}

Expand description

All lifecycle hooks of a call.

Fields§

§on_start: HookList<StartEvent>

The call started.

§on_step_start: HookList<StepStartEvent>

A step started.

§on_language_model_call_start: HookList<ModelCallStartEvent>

A model call is about to be made.

§on_language_model_call_end: HookList<ModelCallEndEvent>

A model call finished (tool calls parsed, not yet executed).

§on_tool_execution_start: HookList<ToolExecutionStartEvent>

A tool execution started.

§on_tool_execution_end: HookList<ToolExecutionEndEvent>

A tool execution finished.

§on_step_end: HookList<StepResult>

A step finished.

§on_end: HookList<EndEvent>

The call finished.

§on_chunk: HookList<StreamEvent>

Streaming: a transformed event or a provider error entering retry handling.

§on_abort: HookList<AbortEvent>

Streaming: the call was aborted.

Implementations§

impl Hooks

pub fn merged(self, other: Hooks) -> Hooks

Appends the hooks of other after those of self (settings-level callbacks are invoked before call-level callbacks; their futures run concurrently).

pub async fn emit<E: 'static>(list: &[Arc<dyn HookFn<E>>], event: Arc<E>)

Invokes hooks in list order and awaits all returned futures concurrently.

Completion order is unspecified. Unwinding panics from invoking or polling a callback are ignored after the normal panic handler runs. This cannot isolate panics when compiled with panic = "abort".

Trait Implementations§

impl Clone for Hooks

fn clone(&self) -> Hooks

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

impl Debug for Hooks

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

Formats the value using the given formatter. Read more

impl Default for Hooks

fn default() -> Hooks

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

Auto Trait Implementations§

impl !RefUnwindSafe for Hooks

impl !UnwindSafe for Hooks

impl Freeze for Hooks

impl Send for Hooks

impl Sync for Hooks

impl Unpin for Hooks

impl UnsafeUnpin for Hooks

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

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

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

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

fn into(self) -> U

Calls U::from(self).

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

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

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

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

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

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