Struct hyper::header::Authorization

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

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 hyper::header::{Headers, Authorization};

let mut headers = Headers::new();
headers.set(Authorization("let me in".to_owned()));

use hyper::header::{Headers, Authorization, Basic};

let mut headers = Headers::new();
headers.set(
   Authorization(
       Basic {
           username: "Aladdin".to_owned(),
           password: Some("open sesame".to_owned())
       }
   )
);

use hyper::header::{Headers, Authorization, Bearer};

let mut headers = Headers::new();
headers.set(
   Authorization(
       Bearer {
           token: "QWxhZGRpbjpvcGVuIHNlc2FtZQ".to_owned()
       }
   )
);

Trait Implementations

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

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

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

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

This method tests for !=.

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

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

Formats the value using the given formatter.

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

type Target = S

The resulting type after dereferencing.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn deref(&self) -> &S

Dereferences the value.

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

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Mutably dereferences the value.

impl<S: Scheme + Any> Header for Authorization<S> where
    <S as FromStr>::Err: 'static, 

fn header_name() -> &'static str

Returns the name of the header field this belongs to.

fn parse_header(raw: &[Vec<u8>]) -> Result<Authorization<S>>

Parse a header from a raw stream of bytes.

impl<S: Scheme + Any> HeaderFormat for Authorization<S> where
    <S as FromStr>::Err: 'static, 

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

Format a header to be output into a TcpStream.