Struct ChallengeRef

pub struct ChallengeRef<'i> {
    pub scheme: &'i str,
    pub params: Vec<(&'i str, ParamValue<'i>)>,
}

Parsed challenge (scheme and body) using references to the original header value. Produced by crate::parser::ChallengeParser.

This is not directly useful for responding to a challenge; it’s an intermediary for constructing a client that knows how to respond to a specific challenge scheme. In most cases, callers should construct a PasswordClient without directly using ChallengeRef.

Only supports the param form, not the apocryphal token68 form, as described in crate::parser::ChallengeParser.

Fields

scheme: &'i str

The scheme name, which should be compared case-insensitively.

params: Vec<(&'i str, ParamValue<'i>)>

Zero or more parameters.

These are represented as a Vec of key-value pairs rather than a map. Given that the parameters are generally only used once when constructing a challenge client and each challenge only supports a few parameter types, it’s more efficient in terms of CPU usage and code size to scan through them directly.

Implementations

impl<'i> ChallengeRef<'i>

pub fn new(scheme: &'i str) -> Self

Trait Implementations

impl<'i> Clone for ChallengeRef<'i>

fn clone(&self) -> ChallengeRef<'i>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'i> Debug for ChallengeRef<'i>

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

Formats the value using the given formatter.

impl<'i> PartialEq for ChallengeRef<'i>

fn eq(&self, other: &ChallengeRef<'i>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&ChallengeRef<'_>> for BasicClient

Available on crate feature basic-scheme only.

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: &ChallengeRef<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ChallengeRef<'_>> for DigestClient

Available on crate feature digest-scheme only.

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: &ChallengeRef<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ChallengeRef<'_>> for PasswordClient

Tries to create a PasswordClient from the single supplied challenge.

This is a convenience wrapper around PasswordClientBuilder.

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: &ChallengeRef<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'i> Eq for ChallengeRef<'i>

impl<'i> StructuralPartialEq for ChallengeRef<'i>