Struct Collection

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

A collection allows to store and retrieve items.

The collection can be either in a locked or unlocked state, use Collection::lock or Collection::unlock to lock or unlock it.

Using Collection::search_items or Collection::items will return no items if the collection is locked.

Note

If the collection is deleted using Collection::delete any future usage of it API will fail with Error::Deleted.

Implementations

impl<'a> Collection<'a>

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

Retrieve the list of available Item in the collection.

pub async fn label(&self) -> Result<String, Error>

The collection label.

pub async fn set_label(&self, label: &str) -> Result<(), Error>

Set the collection label.

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

Get whether the collection is locked.

pub async fn created(&self) -> Result<Duration, Error>

The UNIX time when the collection was created.

pub async fn modified(&self) -> Result<Duration, Error>

The UNIX time when the collection was modified.

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

Search for items based on their attributes.

pub async fn create_item( &self, label: &str, attributes: &impl AsAttributes, secret: impl Into<Secret>, replace: bool, window_id: Option<WindowIdentifier>, ) -> Result<Item<'a>, Error>

Create a new item on the collection

Arguments

• label - A user visible label of the item.
• attributes - A map of key/value attributes, used to find the item later.
• secret - The secret to store.
• replace - Whether to replace the value if the attributes matches an existing secret.

pub async fn unlock( &self, window_id: Option<WindowIdentifier>, ) -> Result<(), Error>

Unlock the collection.

pub async fn lock( &self, window_id: Option<WindowIdentifier>, ) -> Result<(), Error>

Lock the collection.

pub async fn delete( &self, window_id: Option<WindowIdentifier>, ) -> Result<(), Error>

Delete the collection.

pub fn path(&self) -> &ObjectPath<'_>

Returns collection path

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

Stream yielding when new items get created

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

Stream yielding when existing items get changed

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

Stream yielding when existing items get deleted

Trait Implementations

impl<'a> Debug for Collection<'a>

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

Formats the value using the given formatter.