Enum Keyring 

pub enum Keyring {
    // some variants omitted
}

A Secret Service or file backed keyring implementation.

It will automatically use the file backend if the application is sandboxed and otherwise falls back to the DBus service using it default collection.

The File backend requires a org.freedesktop.portal.Secret implementation to retrieve the key that will be used to encrypt the backend file.

Implementations

impl Keyring

pub async fn new() -> Result<Self>

Create a new instance of the Keyring.

Auto-detects whether the application is sandboxed and uses the appropriate backend (file backend for sandboxed apps, D-Bus service for host apps). Falls back to D-Bus if the secret portal is not available.

pub async fn sandboxed() -> Result<Self>

Use the file backend with secret portal (for sandboxed apps).

pub async fn sandboxed_with_path( path: impl AsRef<Path>, secret: Secret, ) -> Result<Self>

Use the file backend with a custom path.

Arguments

• path - Path to the keyring file
• secret - Secret to unlock the keyring (use Secret::sandboxed() or Secret::random() for tests)

pub async fn host() -> Result<Self>

Use the D-Bus Secret Service.

pub async fn host_with_connection(connection: Connection) -> Result<Self>

Use the D-Bus Secret Service with a custom connection.

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

Unlock the used collection.

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

Lock the used collection.

pub async fn is_locked(&self) -> Result<bool>

Whether the keyring is locked or not.

pub async fn delete(&self, attributes: &impl AsAttributes) -> Result<()>

Remove items that matches the attributes.

pub async fn items(&self) -> Result<Vec<Item>>

Retrieve all the items.

pub async fn create_item( &self, label: &str, attributes: &impl AsAttributes, secret: impl Into<Secret>, replace: bool, ) -> Result<()>

Create a new item.

pub async fn search_items( &self, attributes: &impl AsAttributes, ) -> Result<Vec<Item>>

Find items based on their attributes.

Trait Implementations

impl Debug for Keyring

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

Formats the value using the given formatter.