Skip to main content

Credentials

Enum Credentials 

Source
#[non_exhaustive]
pub enum Credentials { Basic { username: String, password: String, }, Digest { username: String, password: String, }, Bearer { token: String, }, }
Expand description

Credentials for one of the supported auth schemes.

Basic and Digest both carry a username/password and are treated identically by crate::respond/crate::Authenticator: which wire scheme is actually used is decided by the server’s challenge, not by which variant was constructed (RFC 7235 content negotiation — a server may offer either, or both, in WWW-Authenticate). Use Credentials::new for the common password case; construct Basic/Digest directly only when the caller must pin one scheme.

Variants (Non-exhaustive)§

This enum is marked as 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

Username/password for HTTP Basic auth (RFC 7617) — or RTSP’s reuse of it (RFC 2326 §14/§16).

Fields

§username: String

Account username.

§password: String

Account password.

§

Digest

Username/password for HTTP Digest auth (RFC 7616) — or RTSP’s reuse of it (RFC 2326 §14).

Fields

§username: String

Account username.

§password: String

Account password.

§

Bearer

A bearer token (RFC 6750) — sent verbatim as Authorization: Bearer <token> with no challenge round-trip required.

Fields

§token: String

The opaque bearer token.

Implementations§

Source§

impl Credentials

Source

pub fn new( username: impl Into<String>, password: impl Into<String>, ) -> Credentials

Convenience constructor for the common password-based case.

Does not commit to Basic or Digest: crate::respond/ crate::Authenticator::from_challenge answer whichever scheme the server’s WWW-Authenticate challenge advertises. Internally this builds a Digest value (the superset — http-auth’s challenge parser inspects the challenge itself, not this variant, to pick the wire scheme), so new("u", "p") behaves identically to a hand-constructed Basic/Digest with the same username/password.

Source

pub fn bearer(token: impl Into<String>) -> Credentials

Constructs a bearer-token credential (RFC 6750).

Trait Implementations§

Source§

impl Clone for Credentials

Source§

fn clone(&self) -> Credentials

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Credentials

Manual Debug (rather than #[derive(Debug)]): every scheme carries a secret (password/token) that must never render verbatim. Usernames are not secret and are shown as-is to keep the output useful for diagnostics.

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Credentials

Source§

impl PartialEq for Credentials

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Credentials

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V