Struct task_local_extensions::Extensions

pub struct Extensions { /* private fields */ }

Extensions is a type map: values are stored and retrieved using their TypeId.

This allows storing arbitrary data that implements Sync + Send + 'static. This is useful when you need to share data between different middlewares in the middleware chain or make some values available from the handler to middlewares on the outgoing path (e.g. error class).

Implementations

impl Extensions

pub fn new() -> Self

Create an empty Extensions.

pub fn with<T: Send + Sync + 'static>(self, val: T) -> Self

Insert a value ino this Extensions, returning self instead of any pre-inserted values.

This is useful for any builder style patterns

let ext = Extensions::new().with(true).with(5_i32);
assert_eq!(ext.get(), Some(&true));
assert_eq!(ext.get(), Some(&5_i32));

pub fn append(&mut self, other: &mut Self)

Removes the values from other and inserts them into self.

pub fn insert<T: Send + Sync + 'static>(&mut self, val: T) -> Option<T>

Insert a value into this Extensions.

If a value of this type already exists, it will be returned.

pub fn contains<T: 'static>(&self) -> bool

Check if container contains value for type

pub fn get<T: 'static>(&self) -> Option<&T>

Get a reference to a value previously inserted on this Extensions.

pub fn get_mut<T: 'static>(&mut self) -> Option<&mut T>

Get a mutable reference to a value previously inserted on this Extensions.

pub fn remove<T: 'static>(&mut self) -> Option<T>

Remove a value from this Extensions.

If a value of this type exists, it will be returned.

pub fn clear(&mut self)

Clear the Extensions of all inserted values.

Trait Implementations

impl Debug for Extensions

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

Formats the value using the given formatter.

impl Default for Extensions

fn default() -> Extensions

Returns the “default value” for a type.