Enum ValueSource 

pub enum ValueSource {
    Literal(String),
    Env(String),
    File {
        path: PathBuf,
        dot_path: String,
        format: Option<String>,
    },
    Stdin,
    Fd(i32),
    Prompt,
    Host {
        scheme: String,
        value: String,
    },
}

Where one value is, decided at parse time and read on demand.

Variants

Literal(String)

Env(String)

File

Fields

path: PathBuf

dot_path: String

format: Option<String>

The format the caller named with file+FORMAT:, if any.

Carried as the caller wrote it: this module decides argv grammar and deliberately knows nothing about document formats, so the name is resolved — and rejected if unknown — where the read happens.

Stdin

Fd(i32)

Prompt

Host

A scheme the host declared and reads itself.

Fields

scheme: String

value: String

Implementations

impl ValueSource

pub fn read(&self) -> Result<String, SourceError>

Read the value.

Errors may quote the file and the parser’s complaint: for an ordinary value, saying what was wrong with it is the whole point of the error. A scalar that is not a string — a port, a boolean — is rendered in its canonical spelling; a collection is refused.

pub fn read_secret(&self) -> Result<SecretString, SourceError>

Read the value as a secret.

The result cannot be printed without SecretString::expose_secret, errors carry nothing that could echo what was read, and a non-string value is refused rather than coerced.

impl ValueSource

pub fn describe(&self) -> String

How this source is named where a result, a log, or an error may be read by someone else. Never the value it resolves to.

Trait Implementations

impl Clone for ValueSource

fn clone(&self) -> ValueSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValueSource

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

Formats the value using the given formatter.

impl Eq for ValueSource

impl PartialEq for ValueSource

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ValueSource