Struct Vault 

pub struct Vault(/* private fields */);

Persistent encrypted local store for profiles, keys, contacts, and remembered lockbox metadata.

The implementation handle is private: callers see the reviewed Vault name and cannot depend on the core storage type.

Implementations

impl Vault

pub fn open_default(password: &SecretString) -> Result<Self>

Opens the default persistent store.

pub fn open_or_create_default(password: &SecretString) -> Result<Self>

Opens or creates the default persistent store.

pub fn create_file( path: impl AsRef<Path>, password: &SecretString, ) -> Result<Self>

Creates a new store at an explicit file path.

pub fn open_file( path: impl AsRef<Path>, password: &SecretString, ) -> Result<Self>

Opens an existing store at an explicit file path.

pub fn open_or_create( root: impl AsRef<Path>, password: &SecretString, ) -> Result<Self>

Opens or creates a store below root.

pub fn replace(root: impl AsRef<Path>, password: &SecretString) -> Result<Self>

Replaces the store below root.

pub fn probe_structure_version( root: impl AsRef<Path>, password: &SecretString, ) -> Result<u32>

Returns the structure version without opening the store for writes.

pub fn root(&self) -> &Path

Returns the store’s containing directory.

pub fn path(&self) -> &Path

Returns the encrypted store file path.

pub fn structure_version(&self) -> Result<u32>

Returns the on-disk structure version.

pub fn store_private_key(&self, name: &str, key: &ContactKeyPair) -> Result<()>

Stores a contact private key under a profile name.

pub fn load_private_key(&self, name: &str) -> Result<ContactKeyPair>

Loads a contact private key for a profile.

pub fn private_key_exists(&self, name: &str) -> Result<bool>

Reports whether a profile private key exists.

pub fn list_private_keys(&self) -> Result<Vec<String>>

Lists profile names with private keys.

pub fn delete_private_key(&self, name: &str) -> Result<()>

Deletes a profile private key and its metadata.

pub fn store_profile_email(&self, name: &str, email: &str) -> Result<()>

Stores a profile’s non-secret email metadata.

pub fn profile_email(&self, name: &str) -> Result<Option<String>>

Reads a profile’s email metadata.

pub fn list_profile_generations(&self, name: &str) -> Result<ProfileHistory>

Lists profile key generations.

pub fn rotate_private_key(&self, name: &str) -> Result<ProfileHistory>

Rotates a profile’s private key.

pub fn load_profile_signing_key( &self, name: &str, ) -> Result<ProfileSigningKeyPair>

Loads the current profile signing identity.

pub fn load_profile_signing_key_generation( &self, name: &str, index: u16, ) -> Result<ProfileSigningKeyPair>

Loads a historical profile signing identity.

pub fn store_contact(&self, name: &str, key: &ContactPublicKey) -> Result<()>

Stores a contact’s public key.

pub fn load_contact(&self, name: &str) -> Result<ContactPublicKey>

Loads a contact’s public key.

pub fn contact_exists(&self, name: &str) -> Result<bool>

Reports whether a contact exists.

pub fn delete_contact(&self, name: &str) -> Result<()>

Deletes a contact’s public key.

pub fn list_contacts(&self) -> Result<Vec<StoredContact>>

Lists stored contacts.

pub fn store_contact_signing_key( &self, name: &str, key: &ProfileSigningPublicKey, ) -> Result<()>

Stores a contact signing public key.

pub fn load_contact_signing_key( &self, name: &str, ) -> Result<ProfileSigningPublicKey>

Loads a contact signing public key.

Trait Implementations

impl Debug for Vault

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

Formats the value using the given formatter.