Skip to main content

PluginControllerAdapter

Struct PluginControllerAdapter 

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

Adapts a plug-in controller (vtable + handle from a cdylib) into a host-owned runtime component.

Implementations§

Source§

impl PluginControllerAdapter

Source

pub unsafe fn new( plugin_name: impl Into<String>, type_name: impl Into<String>, vtable: ValidatedControllerVTable, host: *const ControllerHostVTable, config_json: &str, ) -> Result<PluginControllerAdapter, Error>

Constructs a new adapter by calling the plug-in’s create thunk.

host must point at a process-lifetime ControllerHostVTable. config_json is forwarded verbatim to the plug-in’s PluginController::new implementation.

§Errors

Returns an error if the plug-in’s create thunk panics or returns a null handle.

§Safety

host must outlive the adapter and all controller callbacks.

Source

pub fn prepare(&self, request_json: &str) -> Result<OwnedBytes, Error>

Runs the controller’s static prepare hook.

§Errors

Returns an error if the plug-in rejects the request.

Source

pub fn type_name(&self) -> &str

Returns the canonical type name reported by the plug-in.

Source

pub fn plugin_name(&self) -> &str

Returns the plug-in name (manifest name) the adapter wraps.

Source

pub fn on_start(&mut self) -> Result<(), Error>

Dispatches on_start to the plug-in controller.

§Errors

Returns an error if the plug-in callback fails.

Source

pub fn on_stop(&mut self) -> Result<(), Error>

Dispatches on_stop to the plug-in controller.

§Errors

Returns an error if the plug-in callback fails.

Source

pub fn on_resume(&mut self) -> Result<(), Error>

Dispatches on_resume to the plug-in controller.

§Errors

Returns an error if the plug-in callback fails.

Source

pub fn on_reset(&mut self) -> Result<(), Error>

Dispatches on_reset to the plug-in controller.

§Errors

Returns an error if the plug-in callback fails.

Source

pub fn on_dispose(&mut self) -> Result<(), Error>

Dispatches on_dispose to the plug-in controller.

§Errors

Returns an error if the plug-in callback fails.

Source

pub fn on_degrade(&mut self) -> Result<(), Error>

Dispatches on_degrade to the plug-in controller.

§Errors

Returns an error if the plug-in callback fails.

Source

pub fn on_fault(&mut self) -> Result<(), Error>

Dispatches on_fault to the plug-in controller.

§Errors

Returns an error if the plug-in callback fails.

Source

pub fn on_time_event(&mut self, event: &TimeEvent) -> Result<(), Error>

Dispatches on_time_event to the plug-in controller.

§Errors

Returns an error if the plug-in callback fails.

Trait Implementations§

Source§

impl Debug for PluginControllerAdapter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for PluginControllerAdapter

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Send for PluginControllerAdapter

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> Ungil for T
where T: Send,

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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