Enum PasswordClient

#[non_exhaustive]
pub enum PasswordClient {}

Client for responding to a password challenge.

Typically created via TryFrom implementations for a parsed challenge (crate::ChallengeRef) or unparsed challenges (str, [http::header::HeaderValue], or [http::header::GetAll]). See full example in the crate-level documentation.

For more complex scenarios, see PasswordClientBuilder.

Implementations

impl PasswordClient

pub fn builder() -> PasswordClientBuilder

Builds a new PasswordClient.

See example at PasswordClientBuilder.

pub fn respond(&mut self, p: &PasswordParams<'_>) -> Result<String, String>

Responds to the challenge with the supplied parameters.

The caller should use the returned string as an Authorization or Proxy-Authorization header value.

Trait Implementations

impl Debug for PasswordClient

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

Formats the value using the given formatter.

impl PartialEq for PasswordClient

fn eq(&self, other: &PasswordClient) -> 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 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 TryFrom<&str> for PasswordClient

Tries to create a PasswordClient from the supplied str challenge list.

This is a convenience wrapper around PasswordClientBuilder.

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for PasswordClient

impl StructuralPartialEq for PasswordClient