Struct Extensions

pub struct Extensions { /* private fields */ }

A type map of protocol extensions.

Extensions can be used by Request and Response to store extra data derived from the underlying protocol.

Implementations

impl Extensions

pub const fn new() -> Extensions

Create an empty Extensions.

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

Insert a type into this Extensions.

If a extension of this type already existed, it will be returned.

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

Insert a type only into this Extensions, if the value is Some(T).

See Self::insert for more information.

pub fn extend(&mut self, other: Extensions)

Extend these extensions with another Extensions.

pub fn clear(&mut self)

Clear the Extensions of all inserted extensions.

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

Returns true if the Extensions contains the given type.

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

Get a shared reference to a type previously inserted on this Extensions.

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

Get an exclusive reference to a type previously inserted on this Extensions.

pub fn get_or_insert_with_ext<T: Clone + Send + Sync + 'static>( &mut self, f: impl FnOnce(&Self) -> T, ) -> &mut T

Inserts a value into the map computed from f into if it is None, then returns an exclusive reference to the contained value.

Use the cheaper Self::get_or_insert_with in case you do not need access to the extensions for the creation of T, as this function comes with an extra cost.

pub fn get_or_insert_with<T: Send + Sync + Clone + 'static>( &mut self, f: impl FnOnce() -> T, ) -> &mut T

Inserts a value into the map computed from f into if it is None, then returns an exclusive reference to the contained value.

pub fn get_or_insert_from<T, U>(&mut self, src: U) -> &mut T

where T: Send + Sync + Clone + 'static, U: Into<T>,

Inserts a value into the map computed by converting U into T if it is None then returns an exclusive reference to the contained value.

pub fn get_or_insert<T: Clone + Send + Sync + 'static>( &mut self, fallback: T, ) -> &mut T

Retrieves a value of type T from the context.

If the value does not exist, the given value is inserted and an exclusive reference to it is returned.

pub fn get_or_insert_default<T: Default + Clone + Send + Sync + 'static>( &mut self, ) -> &mut T

Get an extension or T’s Default.

see Extensions::get for more details.

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

Remove a type from this Extensions.

Trait Implementations

impl AsMut<Extensions> for RequestContextExt

fn as_mut(&mut self) -> &mut Extensions

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Extensions> for RequestContextExt

fn as_ref(&self) -> &Extensions

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Extensions

fn clone(&self) -> Extensions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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.

impl From<Extensions> for RequestContextExt

fn from(value: Extensions) -> Self

Converts to this type from the input type.

impl From<RequestContextExt> for Extensions

fn from(value: RequestContextExt) -> Self

Converts to this type from the input type.