Skip to main content

PluginRef

Struct PluginRef 

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

Manager-owned wrapper that pairs a plugin with its authoritative config.

The trusted_config comes from the config loader / manager — never from the plugin itself. The executor reads all scheduling decisions (mode, priority, hooks, capabilities, on_error) from this config.

The plugin receives a copy of its config at construction time so it can read its own settings during hook execution. But the manager/executor never reads config back from the plugin.

Trust flow:

config loader → manager → PluginRef.trusted_config → executor
                       ↘ plugin (receives a copy, cannot influence scheduling)

Implementations§

Source§

impl PluginRef

Source

pub fn new(plugin: Arc<dyn Plugin>, trusted_config: PluginConfig) -> Self

Create a new PluginRef with an independently-sourced config.

The trusted_config must come from the config loader or manager, NOT from plugin.config(). The plugin may hold its own copy for reading during execute(), but the manager never consults it.

Source

pub fn trusted_config(&self) -> &PluginConfig

The authoritative config used by the executor for all decisions.

Source

pub fn plugin(&self) -> &Arc<dyn Plugin>

The plugin implementation (for calling initialize/shutdown).

Source

pub fn id(&self) -> Uuid

Unique identifier assigned at registration. Returned by value — Uuid is Copy (16 bytes).

Source

pub fn name(&self) -> &str

Convenience: plugin name from the trusted config.

Source

pub fn mode(&self) -> PluginMode

Effective mode — returns Disabled if the runtime circuit breaker has tripped, otherwise returns the configured mode.

Acquire on the load pairs with Release on the disable() store so weak-memory-ordering hardware (ARM64) propagates the disable promptly across threads.

Source

pub fn disable(&self)

Runtime-disable this plugin (one-way circuit breaker).

Called by the executor when a plugin errors with on_error: Disable. All clones of this PluginRef (in HookEntry, etc.) share the same AtomicBool, so the disable is visible across the system.

Release ordering establishes a happens-before with Acquire loads in is_disabled() and mode() — required for correctness on weak-memory hardware (ARM64) where Relaxed allows the new value to remain unobserved by other threads for an unbounded window.

Source

pub fn is_disabled(&self) -> bool

Whether this plugin has been runtime-disabled. Acquire pairs with the Release in disable() (see mode()).

Source

pub fn priority(&self) -> i32

Convenience: plugin priority from the trusted config.

Trait Implementations§

Source§

impl Clone for PluginRef

Source§

fn clone(&self) -> PluginRef

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

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