Struct KeyringEntry

pub struct KeyringEntry {
    pub key: String,
    /* private fields */
}

The representation of a keyring entry.

This struct is a simple wrapper around native::Entry that holds a keyring entry key.

Fields

key: String

The key used to identify the current keyring entry.

Implementations

impl KeyringEntry

pub fn try_new(key: impl ToString) -> Result<Self>

Creates a new keyring entry from a key.

pub async fn get_secret(&self) -> Result<String>

Gets the secret of the keyring entry.

pub async fn find_secret(&self) -> Result<Option<String>>

Finds the secret of the keyring entry.

This function is like KeyringEntry::get_secret, except that it returns None in case the secret cannot be found.

pub async fn set_secret(&self, secret: impl ToString) -> Result<()>

(Re)sets the secret of the keyring entry.

pub async fn try_with_secret(self, secret: impl ToString) -> Result<Self>

(Re)sets the secret of the keyring entry, using the builder pattern.

This function acts like KeyringEntry::set_secret, except that it returns Self instead of ().

pub async fn delete_secret(&self) -> Result<()>

Deletes the secret of the keyring entry.

Trait Implementations

impl Clone for KeyringEntry

fn clone(&self) -> KeyringEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyringEntry

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyringEntry

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<KeyringEntry> for String

fn from(entry: KeyringEntry) -> Self

Returns the key of the current keyring entry.

impl PartialEq for KeyringEntry

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

Two keyring entries are considered equal if their key are equal.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for KeyringEntry

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for KeyringEntry

fn try_from(key: String) -> Result<Self>

Creates a new keyring entry from a String.

This implementation is a wrapper around native::Entry::new, where the service name is taken globally from get_global_service_name.

type Error = Error

The type returned in the event of a conversion error.

impl Eq for KeyringEntry