Struct aries_askar::Store

pub struct Store<B: Backend>(_);

An instance of an opened store

Implementations

impl<B: Backend> Store<B>

pub fn get_profile_name(&self) -> &str

Get the default profile name used when starting a scan or a session

pub async fn rekey( &mut self, method: StoreKeyMethod, pass_key: PassKey<'_> ) -> Result<(), Error>

Replace the wrapping key on a store

pub async fn create_profile( &self, name: Option<String> ) -> Result<String, Error>

Create a new profile with the given profile name

pub async fn remove_profile(&self, name: String) -> Result<bool, Error>

Remove an existing profile with the given profile name

pub async fn scan( &self, profile: Option<String>, category: String, tag_filter: Option<TagFilter>, offset: Option<i64>, limit: Option<i64> ) -> Result<Scan<'static, Entry>, Error>

Create a new scan instance against the store

The result will keep an open connection to the backend until it is consumed

pub async fn session( &self, profile: Option<String> ) -> Result<Session<B::Session>, Error>

Create a new session against the store

pub async fn transaction( &self, profile: Option<String> ) -> Result<Session<B::Session>, Error>

Create a new transaction session against the store

pub async fn close(self) -> Result<(), Error>

Close the store instance, waiting for any shutdown procedures to complete.

Trait Implementations

impl<B: Debug + Backend> Debug for Store<B>

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

Formats the value using the given formatter.