Struct headers::common::authorization::Authorization

pub struct Authorization<C: Credentials>(pub C);

Authorization header, defined in RFC7235

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.

ABNF

Authorization = credentials

Example values

• Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
• Bearer fpKL54jvWmEGVoRdCNjG

Examples

use headers::Authorization;

let basic = Authorization::basic("Aladdin", "open sesame");
let bearer = Authorization::bearer("some-opaque-token").unwrap();

Tuple Fields

0: C

Implementations

impl Authorization<Basic>

pub fn basic(username: &str, password: &str) -> Self

Create a Basic authorization header.

pub fn username(&self) -> &str

View the decoded username.

pub fn password(&self) -> &str

View the decoded password.

impl Authorization<Bearer>

pub fn bearer(token: &str) -> Result<Self, InvalidBearerToken>

Try to create a Bearer authorization header.

pub fn token(&self) -> &str

View the token part as a &str.

Trait Implementations

impl<C: Clone + Credentials> Clone for Authorization<C>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug + Credentials> Debug for Authorization<C>

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

Formats the value using the given formatter.

impl<C: Credentials> Header for Authorization<C>

fn name() -> &'static HeaderName

The name of this header.

fn decode<'i, I: Iterator<Item = &'i HeaderValue>>( values: &mut I, ) -> Result<Self, Error>

Decode this type from an iterator of HeaderValues.

fn encode<E: Extend<HeaderValue>>(&self, values: &mut E)

Encode this type to a HeaderMap.

impl<C: PartialEq + Credentials> PartialEq for Authorization<C>

fn eq(&self, other: &Authorization<C>) -> 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<C: Credentials> StructuralPartialEq for Authorization<C>