Enum CredentialError 

#[non_exhaustive]
pub enum CredentialError {
    NotFound {
        name: String,
    },
    LiteralRefusedInCi,
    Keychain(String),
    ReadOnly,
    Io(Arc<Error>),
}

Failures surfaced by credential retrieval / storage.

Clone is derived — the Io variant wraps its std::io::Error in an Arc precisely to keep the enum cloneable, so subsystems that fan errors out to multiple consumers (telemetry, logs, health-check aggregation) don’t have to allocate a new enum per consumer.

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.

NotFound

No credential found at the named location.

Fields

name: String

Diagnostic-friendly name (env var name, keychain service/account, or a caller-supplied label).

LiteralRefusedInCi

A literal credential was rejected because the process is running under CI.

Detection today is CI=true only — the common convention used by GitHub Actions, GitLab CI, CircleCI, Buildkite, and others. This is a deliberate pragma: broader detection (CI_* globs, provider-specific env vars) produces false positives for developer shells that happen to export CI=1 or CI_SERVER. Tools that want stricter enforcement can set the variable themselves before calling crate::Resolver::resolve.

Keychain(String)

Keychain backend returned an error.

ReadOnly

The backing store does not support the requested mutation (e.g. EnvStore::set — env mutation is explicitly out of scope; set_var requires unsafe for soundness).

Io(Arc<Error>)

Filesystem / I/O failure while interacting with the store. The inner error is Arc-wrapped so CredentialError can remain Clone.

Trait Implementations

impl Clone for CredentialError

fn clone(&self) -> CredentialError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CredentialError

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

Formats the value using the given formatter.

impl Diagnostic for CredentialError

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for CredentialError

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

Formats the value using the given formatter.

impl Error for CredentialError

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 CredentialError

fn from(e: Error) -> Self

Converts to this type from the input type.