Skip to main content

PluginRegistry

Struct PluginRegistry 

Source
pub struct PluginRegistry<App: 'static = ()> { /* private fields */ }
Expand description

Holds every registered Plugin and runs their hooks at the right times.

App is the optional application-wide shared state type; plugins may read it but never mutate it directly. A registry is cheap to clone (inner Rc).

Implementations§

Source§

impl<App: 'static> PluginRegistry<App>

Source

pub fn new() -> Self

Creates an empty registry.

Source

pub fn register<P: Plugin + 'static>(&mut self, plugin: P) -> &'static str
where P::State: Default,

Registers a plugin, storing its initial state. Returns the plugin’s name so callers can wire up its Context if desired. Panics if a plugin with the same name is already registered.

Source

pub fn register_with_state<P: Plugin + 'static>( &mut self, plugin: P, state: P::State, ) -> &'static str

Registers a plugin together with an existing shared state value.

Source

pub fn run_before_render_hooks(&self, app: Option<&App>)

Runs every plugin’s on_before_render hook.

Source

pub fn run_render_hooks(&self, app: Option<&App>)

Runs every plugin’s on_render hook, then advances the render counter.

Source

pub fn run_shutdown_hooks(&self, app: Option<&App>)

Runs every plugin’s on_shutdown hook.

Source

pub fn len(&self) -> usize

Number of registered plugins.

Source

pub fn is_empty(&self) -> bool

Whether the registry has no plugins.

Source

pub fn bump_render_count(&self)

Advances the internal render counter (called by the host once per completed render). run_render_hooks does not do this itself so the count is stable for the duration of a render.

Trait Implementations§

Source§

impl<App: 'static> Clone for PluginRegistry<App>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<App: 'static> Default for PluginRegistry<App>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<App = ()> !RefUnwindSafe for PluginRegistry<App>

§

impl<App = ()> !Send for PluginRegistry<App>

§

impl<App = ()> !Sync for PluginRegistry<App>

§

impl<App = ()> !UnwindSafe for PluginRegistry<App>

§

impl<App> Freeze for PluginRegistry<App>

§

impl<App> Unpin for PluginRegistry<App>

§

impl<App> UnsafeUnpin for PluginRegistry<App>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.