Struct websocket::header::Authorization

[+] Show declaration

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

[−] 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 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 for Authorization<S> where
    S: Clone + Scheme, [+]

[+] Show hidden undocumented items

pub fn clone(&self) -> Authorization<S>[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<S> Debug for Authorization<S> where
    S: Debug + Scheme, [+]

[+] Show hidden undocumented items

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl<S> Deref for Authorization<S> where
    S: Scheme, [+]

[+] Show hidden undocumented items

type Target = S

The resulting type after dereferencing.

pub fn deref(&self) -> &S[−]

Dereferences the value.

impl<S> DerefMut for Authorization<S> where
    S: Scheme, [+]

[+] Show hidden undocumented items

pub fn deref_mut(&mut self) -> &mut S[−]

Mutably dereferences the value.

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

[+] Show hidden undocumented items

pub fn header_name() -> &'static str[−]

Returns the name of the header field this belongs to.

pub fn parse_header(raw: &[Vec<u8, Global>]) -> Result<Authorization<S>, Error>[−]

Parse a header from a raw stream of bytes.

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

[+] Show hidden undocumented items

pub fn fmt_header(&self, f: &mut Formatter<'_>) -> Result<(), Error>[−]

Format a header to be output into a TcpStream.

impl<S> PartialEq<Authorization<S>> for Authorization<S> where
    S: PartialEq<S> + Scheme, [+]

[+] Show hidden undocumented items

pub fn eq(&self, other: &Authorization<S>) -> bool[−]

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

pub fn ne(&self, other: &Authorization<S>) -> bool[−]

This method tests for !=.

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