Struct prs_lib::store::Store

pub struct Store {
    pub root: PathBuf,
}

Represents a password store.

Fields

root: PathBuf

Root directory of the password store.

This path is always absolute.

Implementations

impl Store

pub fn open<P: AsRef<str>>(root: P) -> Result<Self>

Open a store at the given path.

pub fn recipients(&self) -> Result<Recipients>

Get the recipient keys for this store.

pub fn sync(&self) -> Sync<'_>

Get a sync helper for this store.

pub fn tomb(&self, quiet: bool, verbose: bool, force: bool) -> Tomb<'_>

Get a tomb helper for this store.

pub fn secret_iter(&self) -> SecretIter

Create secret iterator for this store.

pub fn secret_iter_config(&self, config: SecretIterConfig) -> SecretIter

Create secret iterator for this store with custom configuration.

pub fn secrets(&self, filter: Option<String>) -> Vec<Secret>

List store password secrets.

pub fn find_at(&self, path: &str) -> Option<Secret>

Try to find matching secret at path.

pub fn find(&self, query: Option<String>) -> FindSecret

Try to find matching secrets for given query.

If secret is found at exact query path, FindSecret::Found is returned. Otherwise any number of closely matching secrets is returned as FindSecret::Many.

pub fn normalize_secret_path<P: AsRef<Path>>(
    &self,
    target: P,
    name_hint: Option<&str>,
    create_dirs: bool
) -> Result<PathBuf>

Normalizes a path for a secret in this store.

• Ensures path is within store.
• If directory is given, name hint is appended.
• Sets correct extension.
• Creates parent directories if non existant (optional).

Trait Implementations

impl Clone for Store

fn clone(&self) -> Store

Returns a copy of the value.

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

Performs copy-assignment from source.