Struct hawk::Header

pub struct Header {
    pub id: Option<String>,
    pub ts: Option<SystemTime>,
    pub nonce: Option<String>,
    pub mac: Option<Mac>,
    pub ext: Option<String>,
    pub hash: Option<Vec<u8>>,
    pub app: Option<String>,
    pub dlg: Option<String>,
}

Representation of a Hawk Authorization header value (the part following "Hawk ").

Headers can be derived from strings using the FromStr trait, and formatted into a string using the fmt_header method.

All fields are optional, although for specific purposes some fields must be present.

Fields

id: Option<String>

ts: Option<SystemTime>

nonce: Option<String>

mac: Option<Mac>

ext: Option<String>

hash: Option<Vec<u8>>

app: Option<String>

dlg: Option<String>

Methods

impl Header

pub fn new<S>(
    id: Option<S>,
    ts: Option<SystemTime>,
    nonce: Option<S>,
    mac: Option<Mac>,
    ext: Option<S>,
    hash: Option<Vec<u8>>,
    app: Option<S>,
    dlg: Option<S>
) -> Result<Header> where
    S: Into<String>, 

Create a new Header with the full set of Hawk fields.

This is a low-level function. Headers are more often created from Requests or Responses.

Note that none of the string-formatted header components can contain the character \".

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

Format the header for transmission in an Authorization header, omitting the "Hawk " prefix.

Trait Implementations

impl PartialEq<Header> for Header

fn eq(&self, other: &Header) -> bool

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

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

This method tests for !=.

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for Header

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

Formats the value using the given formatter.

impl Debug for Header

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

Formats the value using the given formatter.

impl FromStr for Header

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Header>

Parses a string s to return a value of this type.