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()))
}

Methods

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: Eq + Scheme> Eq for Authorization<S>

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

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

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

Performs the conversion.

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: Clone + Scheme> Clone for Authorization<S>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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.

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

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

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

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

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

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

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

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

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

fn as_ref(&self) -> &S

Performs the conversion.

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

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

Performs the conversion.

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

fn default() -> Authorization<S>

Returns the "default value" for a type.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Feeds this value into the given [Hasher].

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> IntoHeaderValue for Authorization<S>

type Error = <S as IntoHeaderValue>::Error

The type returned in the event of a conversion error.

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

Try to convert value to a Header value.

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