Skip to main content

PluginConfig

Struct PluginConfig 

Source
pub struct PluginConfig {
Show 14 fields pub name: String, pub on_user_message: Option<OnUserMessageCallback>, pub on_event: Option<OnEventCallback>, pub before_run: Option<BeforeRunCallback>, pub after_run: Option<AfterRunCallback>, pub before_agent: Option<BeforeAgentCallback>, pub after_agent: Option<AfterAgentCallback>, pub before_model: Option<BeforeModelCallback>, pub after_model: Option<AfterModelCallback>, pub on_model_error: Option<OnModelErrorCallback>, pub before_tool: Option<BeforeToolCallback>, pub after_tool: Option<AfterToolCallback>, pub on_tool_error: Option<OnToolErrorCallback>, pub close_fn: Option<Box<dyn Fn() -> Pin<Box<dyn Future<Output = ()> + Send>> + Send + Sync>>,
}
Expand description

Configuration for creating a Plugin.

All callbacks are optional - only set the ones you need.

§Example

let config = PluginConfig {
    name: "my-plugin".to_string(),
    on_user_message: Some(Box::new(|ctx, content| {
        Box::pin(async move {
            // Process user message
            Ok(None)
        })
    })),
    ..Default::default()
};

Fields§

§name: String

Unique name for this plugin

§on_user_message: Option<OnUserMessageCallback>

Called when a user message is received (can modify)

§on_event: Option<OnEventCallback>

Called for each event (can modify)

§before_run: Option<BeforeRunCallback>

Called before the run starts (can skip run)

§after_run: Option<AfterRunCallback>

Called after the run completes (cleanup)

§before_agent: Option<BeforeAgentCallback>

Called before agent execution

§after_agent: Option<AfterAgentCallback>

Called after agent execution

§before_model: Option<BeforeModelCallback>

Called before LLM call (can modify request or skip)

§after_model: Option<AfterModelCallback>

Called after LLM call (can modify response)

§on_model_error: Option<OnModelErrorCallback>

Called when LLM returns an error

§before_tool: Option<BeforeToolCallback>

Called before tool execution

§after_tool: Option<AfterToolCallback>

Called after tool execution

§on_tool_error: Option<OnToolErrorCallback>

Called when tool returns an error

§close_fn: Option<Box<dyn Fn() -> Pin<Box<dyn Future<Output = ()> + Send>> + Send + Sync>>

Cleanup function called when plugin is closed

Trait Implementations§

Source§

impl Default for PluginConfig

Source§

fn default() -> Self

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