Struct headers::authorization::Authorization

source ·
pub struct Authorization<C: Credentials>(pub C);
Expand description

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§

source§

impl Authorization<Basic>

source

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

Create a Basic authorization header.

source

pub fn username(&self) -> &str

View the decoded username.

source

pub fn password(&self) -> &str

View the decoded password.

source§

impl Authorization<Bearer>

source

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

Try to create a Bearer authorization header.

source

pub fn token(&self) -> &str

View the token part as a &str.

Trait Implementations§

source§

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

source§

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

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<C: Debug + Credentials> Debug for Authorization<C>

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn name() -> &'static HeaderName

The name of this header.
source§

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

Decode this type from an iterator of HeaderValues.
source§

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

Encode this type to a HeaderMap. Read more
source§

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

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

Auto Trait Implementations§

§

impl<C> Freeze for Authorization<C>
where C: Freeze,

§

impl<C> RefUnwindSafe for Authorization<C>
where C: RefUnwindSafe,

§

impl<C> Send for Authorization<C>
where C: Send,

§

impl<C> Sync for Authorization<C>
where C: Sync,

§

impl<C> Unpin for Authorization<C>
where C: Unpin,

§

impl<C> UnwindSafe for Authorization<C>
where C: 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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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 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, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
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.
source§

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

Performs the conversion.