Struct Service

pub struct Service<'a> { /* private fields */ }

The entry point of communicating with a org.freedesktop.Secrets implementation.

It will automatically create a session for you and allow you to retrieve collections or create new ones.

Certain actions requires on the Secret Service implementation requires a user prompt to complete like creating a collection, locking or unlocking a collection. The library handles that automatically for you.

use oo7::dbus::Service;

let service = Service::new().await?;
let collection = service.default_collection().await?;
// Do something with the collection

}

Implementations

impl<'a> Service<'a>

pub const DEFAULT_COLLECTION: &'static str = "default"

The default collection alias.

In general, you are supposed to use Service::default_collection.

pub const SESSION_COLLECTION: &'static str = "session"

A session collection.

The collection is cleared when the user ends the session.

pub async fn new() -> Result<Service<'a>, Error>

Create a new instance of the Service, an encrypted communication would be attempted first and would fall back to a plain one if that fails.

pub async fn plain() -> Result<Service<'a>, Error>

Create a new instance of the Service with plain algorithm.

pub async fn encrypted() -> Result<Service<'a>, Error>

Create a new instance of the Service with encrypted algorithm.

pub async fn default_collection(&self) -> Result<Collection<'a>, Error>

Retrieve the default collection if any or create one.

The created collection label is set to Default. If you want to translate the string, use Self::with_alias_or_create instead.

pub async fn session_collection(&self) -> Result<Collection<'a>, Error>

Retrieve the session collection if any or create one.

The created collection label is set to Default. If you want to translate the string, use Self::with_alias_or_create instead.

pub async fn with_alias_or_create( &self, alias: &str, label: &str, window_id: Option<WindowIdentifier>, ) -> Result<Collection<'a>, Error>

pub async fn with_alias( &self, alias: &str, ) -> Result<Option<Collection<'a>>, Error>

Find a collection with it alias.

Applications should make use of Service::default_collection instead.

pub async fn collections(&self) -> Result<Vec<Collection<'a>>, Error>

Get a list of all the available collections.

pub async fn create_collection( &self, label: &str, alias: &str, window_id: Option<WindowIdentifier>, ) -> Result<Collection<'a>, Error>

Create a new collection.

pub async fn with_label( &self, label: &str, ) -> Result<Option<Collection<'a>>, Error>

Find a collection with it label.

pub async fn receive_collection_created( &self, ) -> Result<impl Stream<Item = Collection<'a>> + '_, Error>

Stream yielding when new collections get created

pub async fn receive_collection_changed( &self, ) -> Result<impl Stream<Item = Collection<'a>> + '_, Error>

Stream yielding when existing collections get changed

pub async fn receive_collection_deleted( &self, ) -> Result<impl Stream<Item = OwnedObjectPath>, Error>

Stream yielding when existing collections get deleted

Trait Implementations

impl<'a> Debug for Service<'a>

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

Formats the value using the given formatter.