Enum KeyCommandError 

pub enum KeyCommandError {
    NoProgram,
    NotFound {
        program: String,
    },
    Spawn {
        program: String,
        cause: Error,
    },
    Timeout {
        program: String,
        secs: u64,
    },
    Signal {
        program: String,
    },
    Failed {
        program: String,
        code: i32,
    },
    NotUtf8 {
        program: String,
    },
    Empty {
        program: String,
    },
    Unusable {
        program: String,
    },
    TooMuchOutput {
        program: String,
        limit: usize,
    },
}

Why a configured api_key_command did not produce a usable credential.

Debug is derived, which is safe only because no variant carries captured output. Adding one that did would put a credential into {:?}.

Variants

NoProgram

Reachable only from a hand-built LlmConfig: config::load rejects api_key_command = [] for an enabled entry. Checked anyway, because a panic inside the commit gate is a worse failure than a message.

NotFound

Distinguished from Self::Spawn because the fix is different: this one is a typo in argv[0] or a helper that is not installed, and reporting it as “could not be started: No such file or directory” sends the reader looking at file permissions instead.

Fields

program: String

Spawn

Fields

program: String

cause: Error

Timeout

Fields

program: String

secs: u64

Signal

A helper killed by a signal has no exit code, so it cannot be reported through Self::Failed without inventing one.

Fields

program: String

Failed

The status and nothing else. See the module doc: captured output is where a credential would escape.

Fields

program: String

code: i32

NotUtf8

Fields

program: String

Empty

An empty credential satisfies every “is a key present” check downstream and then 401s, which reads as a rejected key rather than a helper that printed nothing. AuthStore::set refuses an empty paste for the same reason.

Fields

program: String

Unusable

The resolved value becomes an HTTP header, which cannot carry a control character - so a helper that printed two lines, or a diagnostic banner followed by the token, is a guaranteed transport failure. Caught here rather than on the first file of the first push, exactly as AuthStore::set catches it at the prompt.

Fields

program: String

TooMuchOutput

The helper printed more than any credential can be.

A ceiling rather than an unbounded read, for the reason crate::http’s module doc gives: a bound is a safety property, and the failure it names there is a second reader next to a bounded one that kept calling text() with no ceiling at all. This is the third spawn site in the crate and the first with a ceiling, so the doctrine is applied here rather than argued about: an api_key_command pointed at the wrong program - cat on a large file is one keystroke from cat on a token file - would otherwise allocate whatever it printed inside the commit gate, then walk all of it twice to trim it and scan it for control characters.

Reported rather than truncated. Truncating would hand the endpoint a prefix of something that was never a credential and turn a local misconfiguration into a 401 per file.

Fields

program: String

limit: usize

Trait Implementations

impl Debug for KeyCommandError

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

Formats the value using the given formatter.

impl Display for KeyCommandError

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

Formats the value using the given formatter.

impl Error for KeyCommandError

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.