Struct PluginContext 

#[non_exhaustive]
pub struct PluginContext {
    pub vault: VaultApi,
    pub hooks: HookBus,
    pub storage: PluginStorage,
    pub shutdown: ShutdownSignal,
}

Capabilities provided to a plugin when it is constructed.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

vault: VaultApi

Curated vault operations, bound to this plugin’s declaration.

hooks: HookBus

Bounded, advisory hook/event bus.

storage: PluginStorage

Durable, plugin-private, per-vault key/value storage.

shutdown: ShutdownSignal

Cooperative shutdown signal for background work.

Implementations

impl PluginContext

pub fn new( vault: VaultApi, hooks: HookBus, storage: PluginStorage, shutdown: ShutdownSignal, ) -> Self

Assemble a context. Called by the host.

Trait Implementations

impl Clone for PluginContext

fn clone(&self) -> PluginContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginContext

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

Formats the value using the given formatter.