Skip to main content

PluginContext

Struct PluginContext 

Source
pub struct PluginContext {
    pub local_state: HashMap<String, Value>,
    pub global_state: HashMap<String, Value>,
}
Expand description

Per-plugin, per-invocation execution context.

Each plugin receives its own PluginContext with:

  • local_state — private to this plugin, this invocation. Fresh each time. Used for per-plugin counters, caches, scratch data.
  • global_state — shared across all plugins in a pipeline. The executor merges changes back after serial phases so subsequent plugins see contributions from earlier ones.

All data needed for policy evaluation (identity, tenant, request metadata) comes from the payload’s extensions, capability-gated per plugin. Context is purely for transient execution state.

PluginContext
├── local_state: HashMap    # Per-plugin, per-request. Private.
└── global_state: HashMap   # Shared across plugins. Use with care.

Fields§

§local_state: HashMap<String, Value>

Plugin-local state. Private to this plugin, this invocation.

§global_state: HashMap<String, Value>

Shared state across all plugins in the pipeline. The executor merges changes back after each serial-phase plugin.

Implementations§

Source§

impl PluginContext

Source

pub fn new() -> Self

Create a new empty plugin context.

Source

pub fn with_global_state(global_state: HashMap<String, Value>) -> Self

Create a plugin context with pre-populated global state.

Source

pub fn get_local(&self, key: &str) -> Option<&Value>

Get a value from local state.

Source

pub fn set_local(&mut self, key: impl Into<String>, value: Value)

Set a value in local state.

Source

pub fn get_global(&self, key: &str) -> Option<&Value>

Get a value from global state.

Examples found in repository?
examples/plugin_demo.rs (line 137)
129    async fn handle(
130        &self,
131        payload: &ToolInvokePayload,
132        _extensions: &Extensions,
133        ctx: &mut PluginContext,
134    ) -> PluginResult<ToolInvokePayload> {
135        // Check if the user has PII clearance (simulated via context)
136        let has_clearance = ctx
137            .get_global("pii_clearance")
138            .and_then(|v| v.as_bool())
139            .unwrap_or(false);
140
141        if !has_clearance {
142            println!(
143                "  [pii-guard] DENIED: user '{}' lacks PII clearance for '{}'",
144                payload.user, payload.tool_name
145            );
146            return PluginResult::deny(PluginViolation::new(
147                "pii_access_denied",
148                "PII clearance required",
149            ));
150        }
151
152        println!(
153            "  [pii-guard] OK: user '{}' has PII clearance",
154            payload.user
155        );
156        PluginResult::allow()
157    }
Source

pub fn set_global(&mut self, key: impl Into<String>, value: Value)

Set a value in global state.

Trait Implementations§

Source§

impl Clone for PluginContext

Source§

fn clone(&self) -> PluginContext

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 Debug for PluginContext

Source§

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

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

impl Default for PluginContext

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for PluginContext

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PluginContext

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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