Struct PassStore

pub struct PassStore { /* private fields */ }

Represents the underlying directory structure of a password store. The folder structure is inherit from pass(1).

Implementations

impl PassStore

Represents the underlying directory structure of a password store. The folder structure is inherit from pass(1).

On construction of the store, base directory is be walked. All found gpg-files will be treated as store entries, which are represented by PassEntry.

pub fn new() -> Result<PassStore>

Constructs a new PassStore with the default store location.

pub fn from(path: &PathBuf) -> Result<PassStore>

Constructs a new PassStore using the provided location.

Examples

use std::path::PathBuf;
use rasslib::store::PassStore;

let p = PathBuf::from("/home/bar/.store");

let store = PassStore::from(&p);

pub fn set_verbose(&mut self, verbose: bool)

Set the verbose printouts for the store.

pub fn absolute_path(&self, entry: &str) -> PathBuf

Returns the absolute_path of a given PassEntry.

pub fn get_location(&self) -> String

Returns the location of the PassStore as String.

pub fn find<S>(&self, query: S) -> Vec<PassTreePath>

where S: Into<String>,

Find and returns a Vector of PassEntrys by its name.

pub fn get<S>(&self, pass: S) -> Option<PassTreePath>

where S: Into<String>,

Get a PassTreePath from the give parameter pass. Returns an

pub fn read(&self, entry: &PassTreePath) -> Option<String>

Reads and returns the content of the given PassEntry. The for the gpg-file related to the PassEntry encrypt.

pub fn insert<VCS, D>(&mut self, vcs: VCS, entry: &str, data: D) -> Result<()>

where D: Into<Vec<u8>>, VCS: VersionControl,

Inserts a new entry into the store. This creates a new encrypted gpg-file and add it to version control system, provided via vcs.

pub fn remove<VCS>(&mut self, vcs: VCS, entry: &PassTreePath) -> Result<()>

where VCS: VersionControl,

Removes a given PassEntry from the store. Therefore the related gpg-file will be removed from the file-system and the internal entry list. Further the vcs will use to commit that change.

Note that the entry passed into the function shall be a copy of the original reference.

pub fn entries<'a>(&'a self) -> &'a PassTree

Gets all entries from the store as a Tree structure.

pub fn print_tree(&self, path: &PassTreePath)

Prints a give path as a tree. Note, if the path does not point to any entry in the store, nothing will be printed!

pub fn grep(&self, searcher: &str, grep_args: &Vec<&str>) -> Result<String>

Executes over all entries in the store with the given search parameters. Take note that grep_args can include all grep parameters which are relevant for a piped grep execution. However, the last parameter shall always be the grep command.

Trait Implementations

impl Debug for PassStore

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

Formats the value using the given formatter.