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 into_frozen_extensions(self) -> Arc<Extensions>

Convert Extensions into a frozen/readonly variant

pub fn maybe_with_parent_extensions( self, frozen_extensions: Option<Arc<Extensions>>, ) -> Extensions

Set parent extensions

pub fn maybe_set_parent_extensions( &mut self, frozen_extensions: Option<Arc<Extensions>>, ) -> &mut Extensions

Set parent extensions

pub fn with_parent_extensions( self, frozen_extensions: Arc<Extensions>, ) -> Extensions

Set parent extensions

pub fn set_parent_extensions( &mut self, frozen_extensions: Arc<Extensions>, ) -> &mut Extensions

Set parent extensions

pub fn without_parent_extensions(self) -> Extensions

Set parent extensions

pub fn unset_parent_extensions(&mut self) -> &mut Extensions

Set parent extensions

pub fn insert<T>(&mut self, val: T) -> Option<T>

where T: Clone + Send + Sync + 'static,

Insert a type into this Extensions.

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

pub fn insert_mut<T>(&mut self, val: T) -> &mut T

where T: Clone + Send + Sync + 'static,

Insert a type into this Extensions and get mutable reference

pub fn maybe_insert<T>(&mut self, val: Option<T>) -> Option<T>

where T: Clone + Send + Sync + 'static,

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>(&self) -> bool

where T: Send + Sync + 'static,

Returns true if the Extensions or parents contains the given type.

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

where T: Send + Sync + 'static,

Get a shared reference to a type previously inserted on this Extensions or any of the parents

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

where T: Send + Sync + 'static,

Get an exclusive reference to a type previously inserted on 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<(), Error>

Formats the value using the given formatter.

impl Default for Extensions

fn default() -> Extensions

Returns the “default value” for a type.

impl ExtensionsMut for Extensions

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

Get mutable reference to the underlying Extensions store

fn take_extensions(&mut self) -> Extensions

impl ExtensionsRef for Extensions

fn extensions(&self) -> &Extensions

Get reference to the underlying Extensions store

impl From<Extensions> for RequestContextExt

fn from(value: Extensions) -> RequestContextExt

Converts to this type from the input type.

impl From<Extensions> for RequestExtensions

fn from(value: Extensions) -> RequestExtensions

Converts to this type from the input type.

impl From<RequestContextExt> for Extensions

fn from(value: RequestContextExt) -> Extensions

Converts to this type from the input type.

impl<State> FromRequestContextRefPair<State> for Extensions

where State: Send + Sync,

type Rejection = Infallible

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_context_ref_pair( parts: &Parts, _state: &State, ) -> Result<Extensions, <Extensions as FromRequestContextRefPair<State>>::Rejection>

Perform the extraction.

impl IntoResponse for Extensions

fn into_response(self) -> Response

Create a response.

impl IntoResponseParts for Extensions

type Error = Infallible

The type returned in the event of an error.

fn into_response_parts( self, res: ResponseParts, ) -> Result<ResponseParts, <Extensions as IntoResponseParts>::Error>

Set parts of the response