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 fn new() -> Extensions

Create an empty Extensions store.

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

where T: Extension + Clone,

Insert a type into this [Extensions] store.

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

Extend this Extensions store with the Extensions from the provided store

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

where T: Extension + Clone,

Returns true if the Extensions store contains the given type.

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

where T: Extension + Clone,

Get a shared reference to the most recently insert item of type T

Note: Self::get will return the last added item T, in most cases this is exactly what you want, but if you need the oldest item T use Self::first

pub fn get_or_insert<T, F>(&mut self, create_fn: F) -> &T

where T: Extension + Clone, F: FnOnce() -> T,

Get a shared reference to the most recently insert item of type T, or insert in case no item was found

Note: Self::get will return the last added item T, in most cases this is exactly what you want, but if you need the oldest item T use Self::first

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

where T: Extension + Clone,

Get a shared reference to the oldest inserted item of type T

Note: Self::first will return the first added item T, in most cases this is not what you want, instead use Self::get to get the most recently inserted item T

pub fn iter<T>(&self) -> impl Iterator<Item = &T>

where T: Extension + Clone,

Iterate over all the inserted items of type T

Note: items are ordered from oldest to newest

Trait Implementations

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

impl ExtensionsRef for Extensions

fn extensions(&self) -> &Extensions

Get reference to the underlying Extensions store

impl From<Extensions> for RequestExtensions

fn from(value: Extensions) -> RequestExtensions

Converts to this type from the input type.

impl FromRequest for Extensions

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( req: Request, ) -> Result<Extensions, <Extensions as FromRequest>::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