Struct Challenge 

pub struct Challenge<'a> { /* private fields */ }

One challenge.

Examples

use parse_net::{auth, Limits};

let c = auth::parse_challenges(b"Bearer realm=\"api\", error=invalid_token", &Limits::DEFAULT)?;
let first = c.iter().next().expect("one challenge");
assert!(first.scheme_is("bearer"));
assert!(first.param("error").is_some_and(|v| v.eq_bytes(b"invalid_token")));

Implementations

impl<'a> Challenge<'a>

pub const fn scheme(&self) -> &'a [u8]

The scheme, as sent.

Examples

use parse_net::{auth, Limits};

let c = auth::parse_challenges(b"Basic realm=\"x\", Negotiate", &Limits::DEFAULT)?;
let schemes: Vec<&[u8]> = c.iter().map(|x| x.scheme()).collect();
assert_eq!(schemes, [&b"Basic"[..], b"Negotiate"]);

pub fn scheme_is(&self, s: &str) -> bool

Whether the scheme is s (ASCII case-insensitive).

Examples

use parse_net::{auth, Limits};

let c = auth::parse_challenges(b"NEGOTIATE", &Limits::DEFAULT)?;
assert!(c.iter().next().is_some_and(|x| x.scheme_is("negotiate")));

pub const fn payload(&self) -> AuthPayload<'a>

The payload.

Examples

use parse_net::{auth, AuthPayload, Limits};

let c = auth::parse_challenges(b"Negotiate abc==", &Limits::DEFAULT)?;
let first = c.iter().next().expect("one challenge");
assert_eq!(first.payload(), AuthPayload::Token68(b"abc=="));

pub fn param(&self, name: &str) -> Option<Word<'a>>

The parameter name (realm, error, scope, …).

Examples

use parse_net::{auth, Limits};

let c = auth::parse_challenges(b"Basic realm=\"simple\", charset=UTF-8", &Limits::DEFAULT)?;
let first = c.iter().next().expect("one challenge");
assert!(first.param("Realm").is_some_and(|v| v.eq_bytes(b"simple")));
assert!(first.param("scope").is_none());

Trait Implementations

impl<'a> Clone for Challenge<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Challenge<'a>

impl<'a> Debug for Challenge<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Challenge<'a>

impl<'a> Hash for Challenge<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Challenge<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for Challenge<'a>