Struct DbView

pub struct DbView<P: BoxProvider> {
    pub vaults: HashMap<VaultId, Vault<P>>,
}

A view over the data inside of a collection of Vault types.

Fields

vaults: HashMap<VaultId, Vault<P>>

A hashmap of the Vault types.

Implementations

impl<P: BoxProvider> DbView<P>

pub fn new() -> DbView<P>

Create a new DbView to interface with the Vault types in the database.

pub fn init_vault(&mut self, key: &Key<P>, vid: VaultId)

Initialize a new Vault if it doesn’t exist.

pub fn write( &mut self, key: &Key<P>, vid: VaultId, rid: RecordId, data: &[u8], record_hint: RecordHint, ) -> Result<(), RecordError<P::Error>>

Write a new record to a Vault. Will instead update a Record if it already exists.

pub fn list_hints_and_ids( &self, key: &Key<P>, vid: VaultId, ) -> Vec<(RecordId, RecordHint)>

Lists all of the RecordHint values and RecordId values for the given Vault.

pub fn contains_vault(&self, vid: &VaultId) -> bool

Check to see if a vault with the given VaultId is present.

pub fn contains_record(&self, vid: VaultId, rid: RecordId) -> bool

Check to see if a Vault contains a Record through the given RecordId.

pub fn get_blob_id( &self, key: &Key<P>, vid: VaultId, rid: RecordId, ) -> Result<BlobId, VaultError<P::Error>>

Get the BlobId of the blob stored in the specified Record. The BlobId changes each time the record’s content is updated.

pub fn get_guard<T, E, F>( &self, key: &Key<P>, vid: VaultId, rid: RecordId, f: F, ) -> Result<T, VaultError<P::Error, E>>

where F: FnOnce(Buffer<u8>) -> Result<T, E>, E: Debug,

Get access the decrypted Buffer of the specified Record.

pub fn get_guards<T, E, F, const N: usize>( &self, ids: [(Key<P>, VaultId, RecordId); N], f: F, ) -> Result<T, VaultError<P::Error, E>>

where F: FnOnce([Buffer<u8>; N]) -> Result<T, E>, E: Debug,

pub fn exec_procedure<T, E, F, const N: usize>( &mut self, sources: [(Key<P>, VaultId, RecordId); N], target_key: &Key<P>, target_vid: VaultId, target_rid: RecordId, hint: RecordHint, f: F, ) -> Result<T, VaultError<P::Error, E>>

where F: FnOnce([Buffer<u8>; N]) -> Result<(Zeroizing<Vec<u8>>, T), E>, E: Debug,

Access the decrypted Buffers of the specified Records and place the return value into the target Record.

pub fn revoke_record( &mut self, key: &Key<P>, vid: VaultId, rid: RecordId, ) -> Result<(), RecordError<P::Error>>

Add a revocation transaction to the Record

pub fn garbage_collect_vault(&mut self, key: &Key<P>, vid: VaultId)

Garbage collect a Vault. Deletes any records that contain revocation transactions.

pub fn clear(&mut self)

Clears the entire Vault from memory.

pub fn list_vaults(&self) -> Vec<VaultId>

List the ids of all vaults.

pub fn list_records(&self, vid: &VaultId) -> Vec<RecordId>

List the ids of all records in the vault.

pub fn list_records_with_blob_id( &self, key: &Key<P>, vid: VaultId, ) -> Result<Vec<(RecordId, BlobId)>, VaultError<P::Error>>

List RecordId and BlobId of all entries in the vault.

pub fn export_all(&self) -> HashMap<VaultId, Vec<(RecordId, Record)>>

Clone the all records from all vaults without removing them.

pub fn export_records<I>( &self, vid: VaultId, records: I, ) -> Result<Vec<(RecordId, Record)>, VaultError<P::Error>>

where I: IntoIterator<Item = RecordId>,

Clone the specified records from the vault without removing them.

Note: before importing these records to a new vault with DbView::import_records, Record::update_meta has to be called on each Record to re-encrypt it with the target vault’s encryption key.

pub fn import_records( &mut self, old_key: &Key<P>, new_key: &Key<P>, vid: VaultId, records: Vec<(RecordId, Record)>, ) -> Result<(), RecordError<P::Error>>

Import records to the Vault. In case of duplicated records, the existing record is dropped in favor of the new one. Re-encrypt the records with the new key.

Trait Implementations

impl<P: Clone + BoxProvider> Clone for DbView<P>

fn clone(&self) -> DbView<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Default + BoxProvider> Default for DbView<P>

fn default() -> DbView<P>

Returns the “default value” for a type.

impl<'de, P> Deserialize<'de> for DbView<P>

where P: Deserialize<'de> + BoxProvider,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P> Serialize for DbView<P>

where P: Serialize + BoxProvider,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.