Struct Authorization

pub struct Authorization<S: Scheme>(/* private fields */);

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 is generic over an authentication scheme.

Examples

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

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

Implementations

impl<S: Scheme> Authorization<S>

pub fn into_scheme(self) -> S

Consumes Authorization header and returns inner Scheme implementation.

Trait Implementations

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

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

Converts this type into a mutable reference of the (usually inferred) input type.

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

fn as_ref(&self) -> &S

Converts this type into a shared reference of the (usually inferred) input type.

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

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

Converts to this type from the input type.

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

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

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 the header from a HTTP message.

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

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,

Restrict a value to a certain interval.

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

fn eq(&self, other: &Authorization<S>) -> 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<S: PartialOrd + Scheme> PartialOrd 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: &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<S: Scheme> TryIntoHeaderValue for Authorization<S>

type Error = <S as TryIntoHeaderValue>::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: Eq + Scheme> Eq for Authorization<S>

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