Struct actix_web::web::Header

source · [−]

pub struct Header<T>(pub T);

Expand description

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

source

impl<T> Header<T>

source

pub fn into_inner(self) -> T

Unwrap into the inner T value.

Trait Implementations

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

impl<T> Deref for Header<T>

type Target = T

The resulting type after dereferencing.

source

fn deref(&self) -> &T

Dereferences the value.

source

impl<T> DerefMut for Header<T>

source

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

Mutably dereferences the value.

source

impl<T> Display for Header<T> where
T: Display,

source

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

Formats the value using the given formatter. Read more

source

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.

source

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

Create a Self from request parts asynchronously.

source

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

Create a Self from request head asynchronously. Read more

source

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

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

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

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

source

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

This method tests for !=.

source

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

source

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

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

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

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

source

impl<T> StructuralEq for Header<T>

source

impl<T> StructuralPartialEq for Header<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Header<T> where
T: RefUnwindSafe,

impl<T> Send for Header<T> where
T: Send,

impl<T> Sync for Header<T> where
T: Sync,

impl<T> Unpin for Header<T> where
T: Unpin,

impl<T> UnwindSafe for Header<T> where
T: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

source

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

source

impl<T> Formattable for T where
T: Deref,
<T as Deref>::Target: Formattable,

source

Struct actix_web::web::Header

Tuple Fields

Implementations

impl<T> Header<T>

pub fn into_inner(self) -> T

Trait Implementations

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

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

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

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

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

impl<T> Deref for Header<T>

type Target = T

fn deref(&self) -> &T

impl<T> DerefMut for Header<T>

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

impl<T> Display for Header<T> where T: Display,

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

impl<T> FromRequest for Header<T> where T: ParseHeader,

type Error = ParseError

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> StructuralEq for Header<T>

impl<T> StructuralPartialEq for Header<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Header<T> where T: RefUnwindSafe,

impl<T> Send for Header<T> where T: Send,

impl<T> Sync for Header<T> where T: Sync,

impl<T> Unpin for Header<T> where T: Unpin,

impl<T> UnwindSafe for Header<T> where T: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

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

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

impl<T> Display for Header<T> where
T: Display,

impl<T> FromRequest for Header<T> where
T: ParseHeader,

impl<T> RefUnwindSafe for Header<T> where
T: RefUnwindSafe,

impl<T> Send for Header<T> where
T: Send,

impl<T> Sync for Header<T> where
T: Sync,

impl<T> Unpin for Header<T> where
T: Unpin,

impl<T> UnwindSafe for Header<T> where
T: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> Formattable for T where
T: Deref,
<T as Deref>::Target: Formattable,

impl<T> Parsable for T where
T: Deref,
<T as Deref>::Target: Parsable,