Struct actix_web::web::Header

pub struct Header<T>(pub T);

Extract typed headers from the request.

To extract a header, the inner type T must implement the Header trait.

Examples

use actix_web::{get, web, http::header};

#[get("/")]
async fn index(date: web::Header<header::Date>) -> String {
    format!("Request was sent at {}", date.to_string())
}

Tuple Fields

0: T

Implementations

impl<T> Header<T>

pub fn into_inner(self) -> T

Unwrap into the inner T value.

Trait Implementations

impl<T: Clone> Clone for Header<T>

fn clone(&self) -> Header<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Header<T>

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

Formats the value using the given formatter.

impl<T> Deref for Header<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for Header<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T> Display for Header<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T> FromRequest for Header<T>

where T: ParseHeader,

type Error = ParseError

The associated error which can be returned.

type Future = Ready<Result<Header<T>, <Header<T> as FromRequest>::Error>>

Future that resolves to a Self.

fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.

impl<T: Ord> Ord for Header<T>

fn cmp(&self, other: &Header<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Header<T>

fn eq(&self, other: &Header<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for Header<T>

fn partial_cmp(&self, other: &Header<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq> Eq for Header<T>

impl<T> StructuralPartialEq for Header<T>