Enum ApiKey 

pub enum ApiKey {
    NotNeeded,
    Required,
    Value(String),
    Env(String),
}

Where an endpoint’s API key comes from, or that it needs none.

One value rather than three fields. The previous shape — api_key + api_key_env + requires_api_key — could represent eight combinations for four meanings, and the contradictions were not theoretical: “needs a key” was once inferred from “names an environment variable”, so a host holding its key in a vault reported that no credential was required and looked permanently ready. No pair of fields can disagree here.

Variants

NotNeeded

The endpoint takes no key — a local Ollama or llama-server.

Required

A key is required and the host has not supplied one yet. Readiness says so and the credential slot is writable, so a host can prompt for it.

Value(String)

The secret itself. Never enters the environment, so it is not inherited by children this crate spawns — including the bash tool, which would otherwise put the key running the agent within the agent’s reach.

Env(String)

The name of an environment variable, read at run time. For CI and headless runs where a variable is the natural source.

Implementations

impl ApiKey

pub fn is_needed(&self) -> bool

Whether this endpoint needs a key at all.

pub fn env_var(&self) -> Option<&str>

The variable this key is read from, when it is read from one. Lets a host say “set OPENROUTER_API_KEY” only when that is actually the instruction; naming a variable to someone passing a value is a dead end.

Trait Implementations

impl Clone for ApiKey

fn clone(&self) -> ApiKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKey

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

Formats the value using the given formatter.

impl Default for ApiKey

fn default() -> ApiKey

Returns the “default value” for a type.

impl Eq for ApiKey

impl PartialEq for ApiKey

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ApiKey