Enum Error

#[non_exhaustive]
pub enum Error {
    Credential {
        name: String,
        cause: Box<Error>,
    },
    FileRead {
        path: PathBuf,
        cause: Box<Error>,
    },
    InvalidUrl {
        url: String,
    },
    Io(Error),
    Json(Error),
    MissingEntry {
        name: String,
    },
    MissingKeyInPath {
        path: String,
    },
    MissingKeyInSecret {
        secret: String,
        key: String,
    },
    MissingVaultAddr,
    MissingVaultToken(Box<Error>),
    NoBackend,
    NoHomeDirectory,
    NonUnicodePath {
        path: PathBuf,
    },
    Parse {
        input: String,
    },
    Other(Box<dyn Error + Send + Sync + 'static>),
    Secretfile(Box<Error>),
    UndefinedEnvironmentVariable {
        name: String,
        cause: VarError,
    },
    UnexpectedHttpStatus {
        status: StatusCode,
        body: String,
    },
    UnparseableUrl(UrlError),
    Url {
        url: Url,
        cause: Box<Error>,
    },
}

An error returned by credentials.

Variants (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.

Credential

Could not access a secure credential.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

name: String

The name of the credential we couldn’t access.

cause: Box<Error>

The reason why we couldn’t access it.

FileRead

Could not read file.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

path: PathBuf

The file we couldn’t access.

cause: Box<Error>

The reason why we couldn’t access it.

InvalidUrl

We encountered an invalid URL.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

url: String

The invalid URL.

Io(Error)

An error occurred doing I/O.

Json(Error)

We failed to parse JSON data.

MissingEntry

Missing entry in Secretfile.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

name: String

The name of the entry.

MissingKeyInPath

Path is missing a ‘:key’ component.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

path: String

The invalid path.

MissingKeyInSecret

Secret does not have value for specified key.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

secret: String

The name of the secret.

key: String

The key for which we have no value.

MissingVaultAddr

VAULT_ADDR not specified.

MissingVaultToken(Box<Error>)

Cannot get either VAULT_TOKEN or ~/.vault_token.

NoBackend

No credentials backend available.

NoHomeDirectory

Can’t find home directory.

NonUnicodePath

Path cannot be represented as Unicode.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

path: PathBuf

The path which cannot be represented as Unicode.

Parse

Parsing error.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

input: String

The input we couldn’t parse.

Other(Box<dyn Error + Send + Sync + 'static>)

An unspecified kind of error occurred.

Secretfile(Box<Error>)

Can’t read Secretfile.

UndefinedEnvironmentVariable

Undefined environment variable.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

name: String

The name of the environment variable.

cause: VarError

The error we encountered.

UnexpectedHttpStatus

Unexpected HTTP status.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

status: StatusCode

The status we received.

body: String

The HTTP body we received.

UnparseableUrl(UrlError)

We failed to parse a URL.

Url

Could not access URL.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

url: Url

The URL we couldn’t access.

cause: Box<Error>

The reason we couldn’t access it.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for Error

fn from(err: UrlError) -> Self

Converts to this type from the input type.