Enum PasswordOrigin 

pub enum PasswordOrigin {
    Env(&'static str),
    File(PathBuf),
    Prompt,
}

Which PasswordSource supplied the password that read_password returned. Lets a caller name the winning source in its own messages — key-gen uses it to refuse an empty password that came from the environment (a shell expanding an unset variable), and operator commands use it to say which source won.

Variants

Env(&'static str)

The environment variable named here supplied the password.

File(PathBuf)

This file supplied the password.

Prompt

An interactive terminal prompt supplied the password.

Implementations

impl PasswordOrigin

pub fn describe(&self) -> String

A human phrase naming the source, for operator-facing messages — “the environment variable” followed by the variable name, “the password file” followed by the path, or “an interactive prompt”. Plain text with no backticks, and never the password itself.

Trait Implementations

impl Clone for PasswordOrigin

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PasswordOrigin

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

Formats the value using the given formatter.

impl Eq for PasswordOrigin

impl PartialEq for PasswordOrigin

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PasswordOrigin