Struct PluginContext 

pub struct PluginContext { /* private fields */ }

Context passed to a plugin. Registrations are automatically owned by its scope and survive when their returned handles are ignored.

Implementations

impl PluginContext

pub fn isolate<K: ServiceKey>(&self) -> Self

pub fn provide<K: ServiceKey>( &self, value: Arc<K::Value>, ) -> Result<ServiceHandle<K>>

pub fn on<E, H, Fut>(&self, handler: H) -> Result<ListenerHandle>

where E: Event, H: Fn(Context, Arc<E>) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

pub fn on_query<Q, H, Fut>(&self, handler: H) -> Result<ListenerHandle>

where Q: Query, H: Fn(Context, Arc<Q>) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Option<Q::Response>>> + Send + 'static,

pub fn defer<F, Fut>(&self, cleanup: F) -> Result<()>

where F: FnOnce() -> Fut + Send + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

pub fn manage<R: Resource>(&self, resource: R) -> Result<()>

pub fn spawn<F, Fut>(&self, task: F) -> Result<TaskHandle>

where F: FnOnce(CancellationToken) -> Fut + Send + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

Registers a cooperative task. It is spawned only when the activation commits. Disposal waits five seconds, then aborts an unresponsive task.

Methods from Deref<Target = Context>

pub fn scope_id(&self) -> u64

pub fn child(&self) -> Self

Creates a lightweight child context sharing the same runtime.

pub fn isolate<K: ServiceKey>(&self) -> Self

Creates a child where service K resolves in a fresh isolated slot; all other service types continue to inherit their current slots.

pub fn get<K: ServiceKey>(&self) -> Result<Arc<K::Value>>

pub fn try_get<K: ServiceKey>(&self) -> Option<Arc<K::Value>>

pub async fn emit<E: Event>(&self, event: E) -> Result<()>

Invokes listeners serially in registration order.

pub async fn parallel<E: Event>(&self, event: E) -> Result<()>

Invokes all listeners concurrently.

pub async fn query<Q: Query>(&self, query: Q) -> Result<Option<Q::Response>>

Runs query handlers in registration order and returns the first answer.

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

type Target = Context

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.