Struct apollo_router::ExtensionsMutex

pub struct ExtensionsMutex { /* private fields */ }

You can use Extensions to pass data between plugins that is not serializable. Such data is not accessible from Rhai or co-processoers.

This can be accessed at any point in the request lifecycle and is useful for passing data between services. Extensions are thread safe, and must be locked for mutation.

For example: context.extensions().lock().insert::<MyData>(data);

Implementations

impl ExtensionsMutex

pub fn lock(&self) -> ExtensionsGuard<'_>

Locks the extensions for mutation.

It is CRITICAL to avoid holding on to the mutex guard for too long, particularly across async calls. Doing so may cause performance degradation or even deadlocks.

See related clippy lint for examples: https://rust-lang.github.io/rust-clippy/master/index.html#/await_holding_lock

Trait Implementations

impl Clone for ExtensionsMutex

fn clone(&self) -> ExtensionsMutex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExtensionsMutex

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

Formats the value using the given formatter.

impl Default for ExtensionsMutex

fn default() -> ExtensionsMutex

Returns the “default value” for a type.