Skip to main content

PluginContext

Struct PluginContext 

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

A type-safe, concurrent key-value store for plugin shared state.

Uses the TypeMap pattern where each type serves as its own key. Thread-safe via tokio::sync::RwLock for concurrent async access.

§Concurrency

  • Multiple readers can access state concurrently via get and contains.
  • Writers acquire exclusive access via insert and remove.
  • No locks are held across await points — each method acquires and releases the lock within a single operation.

§Examples

use adk_plugin::PluginContext;

#[derive(Clone, Debug)]
struct RateLimitState {
    requests_this_minute: u32,
}

let ctx = PluginContext::new();

// A rate-limiting plugin writes state
ctx.insert(RateLimitState { requests_this_minute: 1 }).await;

// A metrics plugin reads it
if let Some(state) = ctx.get::<RateLimitState>().await {
    println!("Requests: {}", state.requests_this_minute);
}

Implementations§

Source§

impl PluginContext

Source

pub fn new() -> Self

Creates a new empty PluginContext.

§Examples
use adk_plugin::PluginContext;

let ctx = PluginContext::new();
Source

pub async fn insert<T: Send + Sync + 'static>(&self, value: T)

Inserts a value into the context. The type itself is the key.

If a value of the same type already exists, it is replaced. The previous value is discarded.

§Examples
use adk_plugin::PluginContext;

#[derive(Clone, Debug, PartialEq)]
struct Counter(u32);

let ctx = PluginContext::new();
ctx.insert(Counter(1)).await;
ctx.insert(Counter(2)).await; // Replaces the previous value

assert_eq!(ctx.get::<Counter>().await, Some(Counter(2)));
Source

pub async fn get<T: Clone + Send + Sync + 'static>(&self) -> Option<T>

Gets a clone of the stored value for type T.

Returns None if no value of type T has been inserted.

§Examples
use adk_plugin::PluginContext;

#[derive(Clone, Debug, PartialEq)]
struct Name(String);

let ctx = PluginContext::new();

assert_eq!(ctx.get::<Name>().await, None);

ctx.insert(Name("alice".to_string())).await;
assert_eq!(ctx.get::<Name>().await, Some(Name("alice".to_string())));
Source

pub async fn contains<T: Send + Sync + 'static>(&self) -> bool

Checks if a value of type T exists in the context.

§Examples
use adk_plugin::PluginContext;

#[derive(Clone, Debug)]
struct Marker;

let ctx = PluginContext::new();

assert!(!ctx.contains::<Marker>().await);
ctx.insert(Marker).await;
assert!(ctx.contains::<Marker>().await);
Source

pub async fn remove<T: Send + Sync + 'static>(&self) -> Option<T>

Removes a value of type T, returning it if present.

After removal, get and contains for type T will return None and false respectively.

§Examples
use adk_plugin::PluginContext;

#[derive(Clone, Debug, PartialEq)]
struct Token(String);

let ctx = PluginContext::new();
ctx.insert(Token("abc".to_string())).await;

let removed = ctx.remove::<Token>().await;
assert_eq!(removed, Some(Token("abc".to_string())));
assert_eq!(ctx.get::<Token>().await, None);

Trait Implementations§

Source§

impl Default for PluginContext

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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, 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