Skip to main content

SimplePlugin

Struct SimplePlugin 

Source
pub struct SimplePlugin {
    pub load_count: usize,
    pub unload_count: usize,
    pub activate_count: usize,
    pub deactivate_count: usize,
    /* private fields */
}
Expand description

A basic Plugin implementation useful for testing.

Tracks how many times each lifecycle hook has been called.

Fields§

§load_count: usize

Number of times on_load has been called.

§unload_count: usize

Number of times on_unload has been called.

§activate_count: usize

Number of times on_activate has been called.

§deactivate_count: usize

Number of times on_deactivate has been called.

Implementations§

Source§

impl SimplePlugin

Source

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

Create a new simple plugin with the given name and version.

Source

pub fn with_capability(self, cap: PluginCapability) -> Self

Add a capability.

Source

pub fn with_dependency(self, dep: impl Into<String>) -> Self

Add a dependency.

Source

pub fn with_author(self, author: impl Into<String>) -> Self

Set the author.

Source

pub fn with_description(self, desc: impl Into<String>) -> Self

Set the description.

Trait Implementations§

Source§

impl Plugin for SimplePlugin

Source§

fn metadata(&self) -> &PluginMetadata

Returns a reference to the plugin’s metadata.
Source§

fn on_load(&mut self) -> Result<()>

Called when the plugin is loaded. Perform one-time initialisation here.
Source§

fn on_unload(&mut self) -> Result<()>

Called when the plugin is being unloaded. Clean up resources here.
Source§

fn on_activate(&mut self) -> Result<()>

Called when the plugin transitions to the active state.
Source§

fn on_deactivate(&mut self) -> Result<()>

Called when the plugin transitions from active to deactivated.

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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, 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