Skip to main content

PluginHandle

Struct PluginHandle 

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

Handle to an initialized plugin instance

Implementations§

Source§

impl PluginHandle

Source

pub fn new( plugin: Box<dyn Plugin>, config: PluginConfig, ) -> Result<PluginHandle, PluginError>

Create a new plugin handle

Source

pub fn id(&self) -> Option<u64>

Get the handle ID

Source

pub fn state(&self) -> LifecycleState

Get the current lifecycle state

Source

pub fn start(&self) -> Result<(), PluginError>

Start the plugin

Source

pub fn call( &self, type_tag: &str, request: &[u8], ) -> Result<Vec<u8>, PluginError>

Handle a request

Source

pub fn shutdown(&self, timeout_ms: u64) -> Result<(), PluginError>

Shutdown the plugin

Source

pub fn set_log_level(&self, level: LogLevel)

Set the log level

Source

pub fn mark_failed(&self)

Mark the plugin as failed

This is called when a panic is caught at the FFI boundary or when an unrecoverable error occurs. It immediately transitions the plugin to the Failed state.

After calling this method, the plugin will reject all further requests. The host should call plugin_shutdown to clean up resources.

Source

pub fn rejected_request_count(&self) -> u64

Get the count of requests rejected due to concurrency limits

Trait Implementations§

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