Struct CredentialStore 

pub struct CredentialStore { /* private fields */ }

The credential store: auth.json in the agent directory, or memory.

Implementations

impl CredentialStore

pub fn open(path: impl Into<PathBuf>) -> CredentialStore

The store backed by path, loaded now. An unreadable file reads as empty.

pub fn path(&self) -> Option<&Path>

The file behind the store, if any.

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

Why the file cannot be read now, as pi’s store reports it. Reads meanwhile see the last document that could be.

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

The stored credential for provider, if it is a valid one.

pub fn list(&self) -> Vec<(String, CredentialKind)>

Stored providers and their credential kinds, in file order.

pub async fn modify<F, Fut>( &self, provider: &str, change: F, cancel: &CancellationToken, ) -> Result<Option<Credential>, AuthError>

where F: FnOnce(Option<Credential>) -> Fut, Fut: Future<Output = Result<Option<Credential>, AuthError>>,

Replaces provider’s credential with what change returns for the current one, under the lock. None leaves the file untouched. Returns the credential now stored.

pub async fn set( &self, provider: &str, credential: Credential, cancel: &CancellationToken, ) -> Result<(), AuthError>

Stores credential for provider.

pub async fn delete( &self, provider: &str, cancel: &CancellationToken, ) -> Result<(), AuthError>

Removes provider’s credential.

Trait Implementations

impl Debug for CredentialStore

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

Formats the value using the given formatter.

impl Default for CredentialStore

fn default() -> Self

Returns the “default value” for a type.