Struct FileProtectedStorage 

pub struct FileProtectedStorage { /* private fields */ }

Owner-only files in one directory. Secret item kind of namespace ns is ns.kind, the keyring is ns.keyring, record name is ns.name and the lock is ns.lock.

Implementations

impl FileProtectedStorage

pub fn new(directory: PathBuf) -> Self

pub fn directory(&self) -> &Path

pub fn path(&self, namespace: &str, name: &str) -> PathBuf

Trait Implementations

impl ProtectedStorage for FileProtectedStorage

fn list_secrets(&self, namespace: &str) -> StoreResult<HashSet<String>>

Secret items and records share the directory, so both listings name every file of the namespace except its lock.

fn prepare(&self, _namespace: &str) -> StoreResult<()>

Makes the namespace ready before first use.

fn lock(&self, namespace: &str) -> StoreResult<ProtectedStorageLock>

Excludes every other process and store using this namespace until the returned lock is dropped.

fn load_secret( &self, namespace: &str, item: &str, expected_len: usize, ) -> StoreResult<Option<Zeroizing<Vec<u8>>>>

The secret item, which callers expect to be expected_len bytes.

fn create_secret( &self, namespace: &str, item: &str, bytes: &[u8], ) -> StoreResult<()>

Durably saves a secret item that the caller observed absent.

fn delete_secret(&self, namespace: &str, item: &str) -> StoreResult<()>

Deletes a secret item; an absent item is already deleted.

fn read_record( &self, namespace: &str, name: &str, expected_len: usize, ) -> StoreResult<Option<Vec<u8>>>

The record, which callers expect to be expected_len bytes.

fn create_record( &self, namespace: &str, name: &str, bytes: &[u8], ) -> StoreResult<()>

Durably saves a new record; an existing record is a failure.

fn remove_record(&self, namespace: &str, name: &str) -> StoreResult<()>

Removes a record; an absent record is already removed.

fn list_records(&self, namespace: &str) -> StoreResult<HashSet<String>>

Names of every record in the namespace, with the same contract as Self::list_secrets.

fn database_location(&self, database_path: &Path) -> StoreResult<Vec<u8>>

Stable bytes naming where the database lives. With its client_id they name the namespace, so they must not change while the database stays in place. The default is the canonical path, which suits hosts whose paths are stable across launches and updates.