Struct Credentials 

pub struct Credentials { /* private fields */ }

The values a user submitted to log in.

A map rather than a struct because the identifying field varies (email, username, phone) and an application may authenticate on more than one (email plus tenant_id).

Implementations

impl Credentials

pub fn new() -> Credentials

Empty credentials.

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

The usual pair.

pub fn with( self, key: impl Into<String>, value: impl Into<String>, ) -> Credentials

Add a field.

pub fn get(&self, key: &str) -> Option<&str>

Read a field.

pub fn password_value(&self) -> Option<&str>

The submitted password.

pub fn lookup_fields(&self) -> Vec<(&str, &str)>

Every field except password — what a provider looks a user up by.

The password is excluded because it is verified, never queried: a WHERE password = ? against a hash column could never match, and against a plaintext column would be a much worse bug.

pub fn is_empty(&self) -> bool

Whether there is anything to look a user up by.

Trait Implementations

impl Clone for Credentials

fn clone(&self) -> Credentials

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Credentials

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

Formats the value using the given formatter.

impl Default for Credentials

fn default() -> Credentials

Returns the “default value” for a type.

impl Eq for Credentials

impl PartialEq for Credentials

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Credentials