Struct Vault 

pub struct Vault { /* private fields */ }

An in-memory key-value store that can be encrypted to/from the QVLT format.

Keys are stored sorted (BTreeMap) for deterministic output. Values are zeroed from memory when the vault is dropped.

Implementations

impl Vault

pub fn new() -> Self

Create an empty vault.

pub fn from_map(entries: BTreeMap<String, String>) -> Self

Create a vault from an existing map.

pub fn get(&self, key: &str) -> Option<&str>

Get a value by key.

pub fn set( &mut self, key: impl Into<String>, value: impl Into<String>, ) -> Option<String>

Set a key-value pair. Returns the previous value if the key existed.

pub fn delete(&mut self, key: &str) -> Option<String>

Remove a key. Returns the value if it existed.

pub fn keys(&self) -> impl Iterator<Item = &str>

List all key names (sorted).

pub fn iter(&self) -> impl Iterator<Item = (&str, &str)>

Iterate over all key-value pairs (sorted by key).

pub fn len(&self) -> usize

Number of entries.

pub fn is_empty(&self) -> bool

Whether the vault is empty.

pub fn entries_mut(&mut self) -> &mut BTreeMap<String, String>

Get a mutable reference to the underlying map.

pub fn to_map(&self) -> BTreeMap<String, String>

Clone the underlying map. (Cannot move due to Drop impl that zeroes memory.)

pub fn encrypt(&self, passphrase: &str) -> Result<Vec<u8>, VaultError>

Encrypt the vault into QVLT binary format.

Uses a fresh random salt and nonce each time, so calling this twice with the same data produces different ciphertext.

pub fn decrypt(data: &[u8], passphrase: &str) -> Result<Self, VaultError>

Decrypt a QVLT binary blob into a vault.

Returns VaultError::DecryptionFailed if the passphrase is wrong or the data has been tampered with.

pub fn to_shell_exports(&self) -> String

Format all entries as export KEY='VALUE' lines for shell eval.

Single quotes in values are escaped as '\''.

pub fn to_json(&self) -> String

Format all entries as a JSON object.

Trait Implementations

impl Clone for Vault

fn clone(&self) -> Vault

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vault

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

Formats the value using the given formatter.

impl Default for Vault

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Vault

fn drop(&mut self)

Executes the destructor for this type.