Struct StoreFileRef

pub struct StoreFileRef {
    pub path: PathBuf,
}

A reference to a file in the password store

Fields

path: PathBuf

Absolute path to the referenced directory

Implementations

impl StoreFileRef

pub fn name(&self) -> Result<String>

Retrieve the name of the store entry

The name is represented as a relative path from the store root and can be used to retrieve this entry using retrieve.

pub fn encryption_keys(&self) -> Result<Vec<Key>>

Retrieve the encryption keys that are used to encrypt this file

This is a collection of gpg keys which are used as gpg recipients during encryption operations. They are taken from a .gpg-id file that is automatically searched for adjecent to this file and further up in the directory hierarchy.

Example

If you already have a StoreFileRef, you can use this method like so:

assert_eq!(
    store_file_ref.encryption_keys().unwrap()[0].id().unwrap(),
    "8497251104B6F45F"
)

pub fn cipher_io(&self) -> Result<CipherFile>

Get an IO handle to the encrypted content of this file

pub fn plain_io_rw(&self) -> Result<RwPlainFile>

Get a read-write IO handle to the plaintext content of this file

pub fn plain_io_ro(&self) -> Result<RoPlainFile>

Get a read-only IO handle to the plaintext of this file

Trait Implementations

impl Clone for StoreFileRef

fn clone(&self) -> StoreFileRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StoreFileRef

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

Formats the value using the given formatter.

impl Hash for StoreFileRef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for StoreFileRef

fn eq(&self, other: &StoreFileRef) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for StoreFileRef

impl StructuralPartialEq for StoreFileRef