Skip to main content

PluginBuilder

Struct PluginBuilder 

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

Builder for creating plugins with a fluent API.

§Example

let plugin = PluginBuilder::new("my-plugin")
    .on_user_message(|ctx, content| Box::pin(async move { Ok(None) }))
    .on_event(|ctx, event| Box::pin(async move { Ok(None) }))
    .build();

Implementations§

Source§

impl PluginBuilder

Source

pub fn new(name: impl Into<String>) -> Self

Create a new plugin builder with the given name.

Source

pub fn on_user_message(self, callback: OnUserMessageCallback) -> Self

Set the on_user_message callback.

Source

pub fn on_event(self, callback: OnEventCallback) -> Self

Set the on_event callback.

Source

pub fn before_run(self, callback: BeforeRunCallback) -> Self

Set the before_run callback.

Source

pub fn after_run(self, callback: AfterRunCallback) -> Self

Set the after_run callback.

Source

pub fn before_agent(self, callback: BeforeAgentCallback) -> Self

Set the before_agent callback.

Source

pub fn after_agent(self, callback: AfterAgentCallback) -> Self

Set the after_agent callback.

Source

pub fn before_model(self, callback: BeforeModelCallback) -> Self

Set the before_model callback.

Source

pub fn after_model(self, callback: AfterModelCallback) -> Self

Set the after_model callback.

Source

pub fn on_model_error(self, callback: OnModelErrorCallback) -> Self

Set the on_model_error callback.

Source

pub fn before_tool(self, callback: BeforeToolCallback) -> Self

Set the before_tool callback.

Source

pub fn after_tool(self, callback: AfterToolCallback) -> Self

Set the after_tool callback.

Source

pub fn on_tool_error(self, callback: OnToolErrorCallback) -> Self

Set the on_tool_error callback.

Source

pub fn close_fn( self, f: impl Fn() -> Pin<Box<dyn Future<Output = ()> + Send>> + Send + Sync + 'static, ) -> Self

Set the close function.

Source

pub fn build(self) -> Plugin

Build the plugin.

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