Struct AuthPool 

pub struct AuthPool {
    pub pool: HashMap<String, Credential>,
    pub defaults: HashMap<String, String>,
    pub order: HashMap<String, Vec<String>>,
    pub usage_stats: HashMap<String, UsageStats>,
}

The complete auth pool (serialized to TOML).

Fields

pool: HashMap<String, Credential>

defaults: HashMap<String, String>

order: HashMap<String, Vec<String>>

usage_stats: HashMap<String, UsageStats>

Implementations

impl AuthPool

pub fn load(path: &Path) -> Result<Self>

Load auth pool from a TOML file.

pub fn save(&self, path: &Path) -> Result<()>

Save auth pool to a TOML file (permissions 600).

pub fn add(&mut self, name: &str, credential: Credential)

Add a credential to the pool.

pub fn remove(&mut self, name: &str) -> Result<()>

Remove a credential from the pool.

pub fn get(&self, name: &str) -> Option<&Credential>

Get a credential by name.

pub fn get_default(&self, provider: &str) -> Option<(&str, &Credential)>

Get the default credential for a provider.

pub fn set_default(&mut self, name: &str) -> Result<()>

Set a credential as the default for its provider.

pub fn credentials_for_provider( &self, provider: &str, ) -> Vec<(&str, &Credential)>

Get all credentials for a provider, in order.

pub fn providers(&self) -> Vec<String>

List all unique providers.

pub fn all_credentials(&self) -> Vec<(&str, &Credential)>

List all credentials sorted by name.

pub fn next_credential( &self, provider: &str, failed_name: &str, ) -> Option<(&str, &Credential)>

Get the next credential to try for a provider after a failure.

Rotates through the order list, skipping credentials in cooldown.

pub fn record_usage(&mut self, name: &str, success: bool)

Record a usage event for a credential.

impl AuthPool

pub fn import_from_auth_profiles_file( &mut self, path: &Path, ) -> Result<Vec<String>>

Import credentials from an auth-profiles.json file.

pub fn import_from_auth_profiles_json( &mut self, profiles_json: &Value, ) -> Vec<String>

Import credentials from an auth-profiles.json structure.

Trait Implementations

impl Clone for AuthPool

fn clone(&self) -> AuthPool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthPool

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

Formats the value using the given formatter.

impl Default for AuthPool

fn default() -> AuthPool

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AuthPool

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AuthPool

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.