Enum http_auth::PasswordClient

#[non_exhaustive]
pub enum PasswordClient {
    Basic(BasicClient),
    Digest(DigestClient),
}

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.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Basic(BasicClient)

This is supported on crate feature basic-scheme only.

Tuple Fields of Basic

0: BasicClient

Digest(DigestClient)

This is supported on crate feature digest-scheme only.

Tuple Fields of Digest

0: DigestClient

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<PasswordClient> for PasswordClient

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

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<&'_ HeaderValue> for PasswordClient

This is supported on crate feature http only.

Tries to create a PasswordClient from the supplied HeaderValue 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: &HeaderValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ str> for PasswordClient

Tries to create a PasswordClient forom 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 TryFrom<GetAll<'_, HeaderValue>> for PasswordClient

This is supported on crate feature http only.

Tries to create a PasswordClient from the supplied http::header::GetAll challenge lists.

This is a convenience wrapper around PasswordClientBuilder.

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: GetAll<'_, HeaderValue>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for PasswordClient

impl StructuralEq for PasswordClient

impl StructuralPartialEq for PasswordClient