Enum SecretEnvError 

pub enum SecretEnvError {
    Conflict {
        name: String,
        file_var: String,
    },
    CommandConflict {
        set: Vec<String>,
    },
    CommandSplit {
        command_var: String,
        reason: &'static str,
    },
    CommandSpawn {
        command_var: String,
        program: String,
        hint: &'static str,
        source: Error,
    },
    CommandFailed {
        command_var: String,
        program: String,
        status: String,
        detail: String,
    },
    CommandTimedOut {
        command_var: String,
        program: String,
        secs: u64,
    },
    CommandOutputTooLarge {
        command_var: String,
        program: String,
        limit: usize,
    },
    CommandEmptyOutput {
        command_var: String,
        program: String,
    },
    CommandNotUtf8 {
        command_var: String,
        program: String,
    },
    RelativePath {
        file_var: String,
        path: PathBuf,
    },
    Unreadable {
        file_var: String,
        path: PathBuf,
        source: Error,
    },
    Unwritable {
        file_var: String,
        path: PathBuf,
        source: Error,
    },
    HoldsJson {
        file_var: String,
        path: PathBuf,
    },
    NotAFile {
        file_var: String,
        path: PathBuf,
    },
    Empty {
        file_var: String,
        path: PathBuf,
    },
    NotUtf8 {
        file_var: String,
        path: PathBuf,
    },
    LoosePermissions {
        file_var: String,
        path: PathBuf,
        mode: u32,
    },
    WritableByOthers {
        file_var: String,
        path: PathBuf,
        mode: u32,
    },
    WrongOwner {
        file_var: String,
        path: PathBuf,
        owner: u32,
        expected: u32,
    },
}

Why a secret could not be resolved. Messages name variables, paths, modes and uids only — never the secret’s bytes.

Variants

Conflict

NAME and NAME_FILE are both set in the same layer.

Fields

name: String

The variable holding the secret directly.

file_var: String

Its _FILE companion.

CommandConflict

Two or more of NAME, NAME_FILE and NAME_COMMAND are set in the same layer, at least one of them the command.

Fields

set: Vec<String>

The variables that are set, in NAME, NAME_FILE, NAME_COMMAND order.

CommandSplit

The _COMMAND value cannot be split into a program and arguments.

Fields

command_var: String

The variable naming the command.

reason: &'static str

What is wrong with it.

CommandSpawn

The command’s program could not be started.

Fields

command_var: String

The variable naming the command.

program: String

The program (argv[0]); the arguments are never shown.

hint: &'static str

A remedy for a program not found, or empty.

source: Error

The underlying I/O error.

CommandFailed

The command ran but did not exit successfully.

Fields

command_var: String

The variable naming the command.

program: String

The program (argv[0]); the arguments are never shown.

status: String

exit code N or the signal that ended it.

detail: String

Its escaped, truncated standard error as : <text>, or empty.

CommandTimedOut

The command did not finish in time and was killed.

Fields

command_var: String

The variable naming the command.

program: String

The program (argv[0]); the arguments are never shown.

secs: u64

The timeout that expired.

CommandOutputTooLarge

The command wrote more than the accepted amount to standard output.

Fields

command_var: String

The variable naming the command.

program: String

The program (argv[0]); the arguments are never shown.

limit: usize

The most output accepted.

CommandEmptyOutput

The command succeeded but wrote nothing (after trimming one newline).

Fields

command_var: String

The variable naming the command.

program: String

The program (argv[0]); the arguments are never shown.

CommandNotUtf8

The command’s output is not valid UTF-8.

Fields

command_var: String

The variable naming the command.

program: String

The program (argv[0]); the arguments are never shown.

RelativePath

The _FILE value is not an absolute path.

Fields

file_var: String

The variable naming the file.

path: PathBuf

The offending path.

Unreadable

The file could not be opened, inspected, or read.

Fields

file_var: String

The variable naming the file.

path: PathBuf

The file’s path.

source: Error

The underlying I/O error.

Unwritable

The file could not be written.

Fields

file_var: String

The key naming the file.

path: PathBuf

The file’s path.

source: Error

The underlying I/O error.

HoldsJson

An existing secret file to be replaced holds JSON, which no secret this resolver stores does: most likely a client_secret.json.

Fields

file_var: String

The key naming the file.

path: PathBuf

The file’s path.

NotAFile

The path (after following symlinks) is not a regular file.

Fields

file_var: String

The variable naming the file.

path: PathBuf

The file’s path.

Empty

The file is empty (after trimming one trailing newline).

Fields

file_var: String

The variable naming the file.

path: PathBuf

The file’s path.

NotUtf8

The file’s contents are not valid UTF-8.

Fields

file_var: String

The variable naming the file.

path: PathBuf

The file’s path.

LoosePermissions

A file owned by the current user grants group or other permission bits.

Fields

file_var: String

The variable naming the file.

path: PathBuf

The file’s path.

mode: u32

The permission bits found (st_mode & 0o777).

WritableByOthers

A root-owned file that group or other users can write.

Fields

file_var: String

The variable naming the file.

path: PathBuf

The file’s path.

mode: u32

The permission bits found (st_mode & 0o777).

WrongOwner

The file is owned by neither the current user nor root.

Fields

file_var: String

The variable naming the file.

path: PathBuf

The file’s path.

owner: u32

The file’s owner uid.

expected: u32

The effective uid of this process.

Trait Implementations

impl Debug for SecretEnvError

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

Formats the value using the given formatter.

impl Display for SecretEnvError

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

Formats the value using the given formatter.

impl Error for SecretEnvError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.