Struct keyring::Entry

pub struct Entry { /* fields omitted */ }

Implementations

impl Entry

pub fn new(service: &str, username: &str) -> Entry

Create an entry for the given service and username. This maps to a target credential in the default keychain.

pub fn new_with_target(target: &str, service: &str, username: &str) -> Entry

Create an entry for the given target, service, and username. On Linux and Mac, the target is interpreted as naming the collection/keychain to store the credential. On Windows, the target is used directly as the target name of the credential.

pub fn new_with_credential(target: &PlatformCredential) -> Result<Entry>

Create an entry that uses the given credential for storage. Callers can use their own algorithm to produce a platform-specific credential spec for the given service and username and then call this entry with that value.

pub fn set_password(&self, password: &str) -> Result<()>

Set the password for this entry. Any other platform-specific annotations are determined by the mapper that was used to create the credential.

pub fn get_password(&self) -> Result<String>

Retrieve the password saved for this entry. Returns a NoEntry error is there isn’t one.

pub fn get_password_and_credential(
    &self
) -> Result<(String, PlatformCredential)>

Retrieve the password and all the other fields set in the platform-specific credential. This allows retrieving metadata on the credential that were saved by external applications.

pub fn delete_password(&self) -> Result<()>

Delete the password for this entry. (Although the entry itself follows the Rust structure lifecycle, deleting the password deletes the platform credential from secure storage.)

Trait Implementations

impl Debug for Entry

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

Formats the value using the given formatter.