Struct CredentialStore 

pub struct CredentialStore { /* private fields */ }

Manages API key storage in a TOML credentials file at <data_dir>/credentials.toml.

Implementations

impl CredentialStore

pub fn new(data_dir: PathBuf) -> Self

pub fn path(&self) -> &Path

Returns the path to the credentials file.

pub fn get_api_key(&self, provider_id: &str) -> Option<String>

Reads the stored API key for the given provider, or None if not found.

pub fn get_model_api_key(&self, provider_id: &str) -> Option<String>

Reads a stored credential usable for model API calls.

OAuth credentials obtained through OpenAI browser login are excluded: they are account/connector tokens, not OpenAI Platform API keys.

pub fn get_oauth_api_kind(&self, provider_id: &str) -> Option<String>

Returns oauth_api_kind metadata for a stored OAuth token, or None.

pub fn get_api_key_for_account( &self, provider_id: &str, account_id: &str, ) -> Option<String>

pub fn get_model_api_key_for_account( &self, provider_id: &str, account_id: &str, ) -> Option<String>

pub fn has_oauth_credential(&self, provider_id: &str) -> bool

pub fn get_project_account( &self, project_dir: &Path, provider_id: &str, ) -> Option<String>

pub fn set_project_account( &self, project_dir: &Path, provider_id: &str, account_id: &str, ) -> Result<()>

pub fn list_credential_accounts( &self, provider_id: &str, project_dir: Option<&Path>, ) -> Result<Vec<CredentialAccountInfo>>

pub fn is_ignored(&self, provider_id: &str) -> bool

Returns true if the user explicitly ignored this provider (e.g. by deleting an env-provided key).

pub fn list_api_key_providers(&self) -> Result<Vec<String>>

Returns the list of provider ids that have stored API keys.

pub fn get_opencode_api_key(&self) -> Option<String>

Reads an API key from OpenCode’s auth.json file, if it exists.

pub fn set_api_key(&self, provider_id: &str, api_key: &str) -> Result<()>

Stores an API key for the given provider, creating the credentials file if needed.

Note: this replaces the provider’s credential map with a single default account. Prefer Self::add_api_key_account for multi-account.

pub fn add_api_key_account( &self, provider_id: &str, api_key: &str, label: Option<&str>, account_id: Option<&str>, ) -> Result<String>

Add (or update) one API-key account without wiping sibling accounts.

Returns the account_id. When account_id is None, a new id is generated.

pub fn set_default_account( &self, provider_id: &str, account_id: &str, ) -> Result<()>

Set the default account for a provider (global selection).

pub fn set_oauth_credential( &self, provider_id: &str, api_key: &str, oauth_api_kind: &str, ) -> Result<()>

Stores an API key with oauth_api_kind metadata (e.g. “chat-completions” for OAuth tokens that only work with Chat Completions API).

pub fn set_oauth_credential_full( &self, provider_id: &str, api_key: &str, oauth_api_kind: &str, refresh_token: Option<&str>, expires_at: Option<i64>, ) -> Result<()>

Stores an OAuth credential with optional refresh token and expiry.

pub fn get_oauth_refresh_token(&self, provider_id: &str) -> Option<String>

Returns the stored OAuth refresh token, if any.

pub fn get_oauth_expires_at(&self, provider_id: &str) -> Option<i64>

Returns the stored OAuth access-token expiry (unix seconds), if any.

pub fn set_commandcode_credential( &self, provider_id: &str, api_key: &str, metadata: CommandCodeCredentialMetadata, ) -> Result<String>

Stores a Command Code OAuth-created API key and callback metadata.

pub fn get_commandcode_metadata( &self, provider_id: &str, ) -> Option<CommandCodeCredentialMetadata>

pub fn delete_credential_account( &self, provider_id: &str, account_id: &str, ) -> Result<bool>

pub fn delete_api_key(&self, provider_id: &str) -> Result<bool>

Deletes a stored API key and adds the provider to the ignored list. Returns true if a stored key was removed.

pub fn resolve_api_key( &self, provider_id: &str, env_var: &str, ) -> Option<String>

Resolve API key for a provider: env var first (explicit override), then stored credential. Resolves an API key by checking the environment variable first, then the stored credential. Returns None if neither is set.

Trait Implementations

impl Clone for CredentialStore

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CredentialStore

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

Formats the value using the given formatter.