Struct SecretStore 

pub struct SecretStore { /* private fields */ }

One app’s secrets.

Implementations

impl SecretStore

pub fn for_app(app_id: &str) -> SecretStore

The app app_id’s secrets in this target’s secret store, or in the thread’s scope_thread store, or in the process’s own after keep_in_memory_for_process.

pub fn memory(app_id: &str) -> SecretStore

Secrets kept in this process, for tests. Each call is a fresh store.

pub fn with_backend( app_id: &str, backend: Arc<dyn SecretBackend>, ) -> SecretStore

The app app_id’s secrets in a host’s own store.

pub fn app_id(&self) -> &str

pub fn protection(&self) -> Protection

pub async fn get(&self, key: &str) -> Result<Option<Secret>, SecretError>

The secret under key, or None.

Errors

The store is unavailable, refused, or the key is malformed.

pub async fn put( &self, key: &str, value: &[u8], options: PutOptions, ) -> Result<(), SecretError>

Store value under key, replacing any earlier secret.

Errors

The store is unavailable, refused, or the key is malformed.

pub async fn delete(&self, key: &str) -> Result<(), SecretError>

Delete the secret under key. Deleting a missing key succeeds.

Errors

The store is unavailable, refused, or the key is malformed.

pub fn get_blocking(&self, key: &str) -> Result<Option<Secret>, SecretError>

get, blocking the calling thread. Desktop code only.

Errors

As get, and Feature::Blocking unsupported on the web.

pub fn put_blocking( &self, key: &str, value: &[u8], options: PutOptions, ) -> Result<(), SecretError>

put, blocking the calling thread. Desktop code only.

Errors

As put, and Feature::Blocking unsupported on the web.

pub fn delete_blocking(&self, key: &str) -> Result<(), SecretError>

delete, blocking the calling thread. Desktop code only.

Errors

As delete, and Feature::Blocking unsupported on the web.

pub fn probe_blocking(&self) -> Result<(), SecretError>

Whether the store answers on this session, blocking the calling thread. The web store always answers.

Errors

Why it does not.

impl SecretStore

pub fn item(&self, purpose: &'static str, item: &str) -> ItemSecret

The secret one item of a document needs for purpose: a database profile’s password, a connection’s SSH passphrase, an account’s one-time-password seed. The document names the item by its id and never holds the secret; the secret stays in this store on this device.

purpose is one of the app’s own fixed names and contains no /; item is the item’s id in the document.

Trait Implementations

impl Clone for SecretStore

fn clone(&self) -> SecretStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretStore

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

Formats the value using the given formatter.