Struct actix_web_httpauth::headers::authorization::Authorization

pub struct Authorization<S: Scheme>(_);

Authorization header, defined in RFC 7235

The “Authorization” header field allows a user agent to authenticate itself with an origin server – usually, but not necessarily, after receiving a 401 (Unauthorized) response. Its value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

Authorization header is generic over authentication scheme.

Example

fn handler(req: HttpRequest) -> Result<String> {
    let auth = Authorization::<Basic>::parse(&req)?;

    Ok(format!("Hello, {}!", auth.as_ref().user_id()))
}

Implementations

impl<S> Authorization<S> where
    S: Scheme, 

pub fn into_scheme(self) -> S

Consumes Authorization header and returns inner Scheme implementation.

Trait Implementations

impl<S> AsMut<S> for Authorization<S> where
    S: Scheme, 

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

Performs the conversion.

impl<S> AsRef<S> for Authorization<S> where
    S: Scheme, 

fn as_ref(&self) -> &S

Performs the conversion.

impl<S: Clone + Scheme> Clone for Authorization<S>

fn clone(&self) -> Authorization<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug + Scheme> Debug for Authorization<S>

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

Formats the value using the given formatter.

impl<S: Default + Scheme> Default for Authorization<S>

fn default() -> Authorization<S>

Returns the “default value” for a type.

impl<S: Scheme> Display for Authorization<S>

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

Formats the value using the given formatter.

impl<S: Eq + Scheme> Eq for Authorization<S>

impl<S> From<S> for Authorization<S> where
    S: Scheme, 

fn from(scheme: S) -> Authorization<S>

Performs the conversion.

impl<S: Hash + Scheme> Hash for Authorization<S>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<S: Scheme> Header for Authorization<S>

fn name() -> HeaderName

Returns the name of the header field

fn parse<T: HttpMessage>(msg: &T) -> Result<Self, ParseError>

Parse a header

impl<S: Scheme> IntoHeaderValue for Authorization<S>

type Error = <S as IntoHeaderValue>::Error

The type returned in the event of a conversion error.

fn try_into_value(self) -> Result<HeaderValue, Self::Error>

Try to convert value to a HeaderValue.

impl<S: Ord + Scheme> Ord for Authorization<S>

fn cmp(&self, other: &Authorization<S>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<S: PartialEq + Scheme> PartialEq<Authorization<S>> for Authorization<S>

fn eq(&self, other: &Authorization<S>) -> bool

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

fn ne(&self, other: &Authorization<S>) -> bool

This method tests for !=.

impl<S: PartialOrd + Scheme> PartialOrd<Authorization<S>> for Authorization<S>

fn partial_cmp(&self, other: &Authorization<S>) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<S: Scheme> StructuralEq for Authorization<S>

impl<S: Scheme> StructuralPartialEq for Authorization<S>