Struct prs_lib::tomb::Tomb

pub struct Tomb<'a> {
    pub settings: TombSettings,
    // some fields omitted
}

Tomb helper for given store.

Fields

settings: TombSettings

Tomb settings.

Implementations

impl<'a> Tomb<'a>

pub fn new(
    store: &'a Store,
    quiet: bool,
    verbose: bool,
    force: bool
) -> Tomb<'a>

Construct new Tomb helper for given store.

pub fn find_tomb_path(&self) -> Result<PathBuf>

Find the tomb path.

Errors if it cannot be found.

pub fn find_tomb_key_path(&self) -> Result<PathBuf>

Find the tomb key path.

Errors if it cannot be found.

pub fn open(&self) -> Result<Vec<Err>>

Open the tomb.

This will keep the tomb open until it is manually closed. See start_timer().

On success this may return a list with soft-fail errors.

pub fn resize(&self, mbs: u32) -> Result<()>

Resize the tomb.

The Tomb must not be mounted and the size must be larger than the current.

pub fn close(&self) -> Result<()>

Close the tomb.

pub fn prepare(&self) -> Result<()>

Prepare a Tomb store for usage.

• If this store is a Tomb, the tomb is opened.

pub fn start_timer(&self, sec: u32, force: bool) -> Result<()>

Set up a timer to automatically close password store tomb.

TODO: add support for non-systemd systems

pub fn has_timer(&self) -> Result<bool>

Check whether the timer is running.

pub fn stop_timer(&self) -> Result<()>

Stop automatic close timer if any is running.

pub fn finalize(&self) -> Result<()>

Finalize the Tomb.

pub fn init(&self, key: &Key, mbs: u32) -> Result<()>

Initialize tomb.

mbs is the size in megabytes.

The given GPG key is used to encrypt the Tomb key with.

Panics

Panics if given key is not a GPG key.

pub fn is_tomb(&self) -> bool

Check whether the password store is a tomb.

This guesses based on existence of some files. If this returns false you may assume this password store doesn’t use a tomb.

pub fn is_open(&self) -> Result<bool>

Check whether the password store is currently opened.

This guesses based on mount information for the password store directory.

pub fn fetch_size_stats(&self) -> Result<TombSize>

Fetch Tomb size statistics.

This is expensive.