Struct AuthParams 

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

Comma-separated auth-params, validated.

Debug prints the parameter names only: values can be secrets.

Examples

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

let c = auth::parse_credentials(b"Digest username=\"a\", realm=\"r\"", &Limits::DEFAULT)?;
let AuthPayload::Params(p) = c.payload() else { unreachable!() };
assert_eq!(p.len(), 2);
assert!(p.get("realm").is_some_and(|v| v.eq_bytes(b"r")));

Implementations

impl<'a> AuthParams<'a>

pub fn iter(&self) -> impl Iterator<Item = (&'a [u8], Word<'a>)> + use<'a>

The parameters, in order.

Examples

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

let c = auth::parse_credentials(b"Digest username=\"a\", nc=1", &Limits::DEFAULT)?;
let AuthPayload::Params(p) = c.payload() else { unreachable!() };
let names: Vec<&[u8]> = p.iter().map(|(n, _)| n).collect();
assert_eq!(names, [&b"username"[..], b"nc"]);

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

The value of the parameter name (ASCII case-insensitive).

Examples

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

let c = auth::parse_credentials(b"Digest Realm=\"api\"", &Limits::DEFAULT)?;
let AuthPayload::Params(p) = c.payload() else { unreachable!() };
assert!(p.get("realm").is_some_and(|v| v.eq_bytes(b"api")));
assert!(p.get("nonce").is_none());

pub const fn len(&self) -> usize

The number of parameters.

Examples

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

let c = auth::parse_credentials(b"Digest a=1, b=2, c=3", &Limits::DEFAULT)?;
let AuthPayload::Params(p) = c.payload() else { unreachable!() };
assert_eq!(p.len(), 3);

pub const fn is_empty(&self) -> bool

Whether there are no parameters.

Examples

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

let c = auth::parse_credentials(b"Digest a=1", &Limits::DEFAULT)?;
let AuthPayload::Params(p) = c.payload() else { unreachable!() };
assert!(!p.is_empty());

Trait Implementations

impl<'a> Clone for AuthParams<'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 AuthParams<'a>

impl Debug for AuthParams<'_>

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

Formats the value using the given formatter.

impl<'a> Eq for AuthParams<'a>

impl<'a> Hash for AuthParams<'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 AuthParams<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for AuthParams<'a>