Struct digest_auth::AuthContext

pub struct AuthContext<'a> {
    pub username: Cow<'a, str>,
    pub password: Cow<'a, str>,
    pub uri: Cow<'a, str>,
    pub body: Option<Cow<'a, [u8]>>,
    pub method: HttpMethod<'a>,
    pub cnonce: Option<Cow<'a, str>>,
}

Login attempt context

All fields are borrowed to reduce runtime overhead; this struct should not be stored anywhere, it is normally meaningful only for the one request.

Fields

username: Cow<'a, str>

Login username

password: Cow<'a, str>

Login password (plain)

uri: Cow<'a, str>

Requested URI (not a domain! should start with a slash)

body: Option<Cow<'a, [u8]>>

Request payload body - used for auth-int (auth with integrity check) May be left out if not using auth-int

method: HttpMethod<'a>

HTTP method used (defaults to GET)

cnonce: Option<Cow<'a, str>>

Spoofed client nonce (use only for tests; a random nonce is generated automatically)

Implementations

impl<'a> AuthContext<'a>

pub fn new<UN, PW, UR>(username: UN, password: PW, uri: UR) -> Self where
    UN: Into<Cow<'a, str>>,
    PW: Into<Cow<'a, str>>,
    UR: Into<Cow<'a, str>>, 

Construct a new context with the GET verb and no payload body. See the other constructors if this does not fit your situation.

pub fn new_post<UN, PW, UR, BD>(
    username: UN,
    password: PW,
    uri: UR,
    body: Option<BD>
) -> Self where
    UN: Into<Cow<'a, str>>,
    PW: Into<Cow<'a, str>>,
    UR: Into<Cow<'a, str>>,
    BD: Into<Cow<'a, [u8]>>, 

Construct a new context with the POST verb and a payload body (may be None). See the other constructors if this does not fit your situation.

pub fn new_with_method<UN, PW, UR, BD>(
    username: UN,
    password: PW,
    uri: UR,
    body: Option<BD>,
    method: HttpMethod<'a>
) -> Self where
    UN: Into<Cow<'a, str>>,
    PW: Into<Cow<'a, str>>,
    UR: Into<Cow<'a, str>>,
    BD: Into<Cow<'a, [u8]>>, 

Construct a new context with arbitrary verb and, optionally, a payload body

pub fn set_custom_cnonce<CN>(&mut self, cnonce: CN) where
    CN: Into<Cow<'a, str>>, 

Set cnonce to the given value

Trait Implementations

impl<'a> Debug for AuthContext<'a>

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

Formats the value using the given formatter.