Struct TableDB 

pub struct TableDB { /* private fields */ }

A handle to an opened encrypted key-value table. Cheap to clone; clones share the same underlying database.

Implementations

impl TableDB

pub fn table_name(&self) -> String

Get the internal name of the table

pub fn io_stats(&self, kind: IoStatsKind) -> IoStats

Get the io stats for the table

pub async fn cleanup(&self) -> VeilidAPIResult<()>

Cleanup the database

Blocks on on-disk database maintenance (vacuum).

Errors with VeilidAPIError::Internal if the backing-store vacuum fails.

pub fn get_column_count(&self) -> VeilidAPIResult<u32>

Get the total number of columns in the TableDB. Not the number of columns that were opened, rather the total number that could be opened.

Errors with VeilidAPIError::Generic if the backing store fails to report its column count.

pub fn estimate_storage_size( &self, _col: u32, key: &[u8], value: &[u8], ) -> VeilidAPIResult<u64>

Estimate the storage size for a table entry Overestimates size on disk because records are compressed in the tabledb Rough guess for sqlite based on their file format. Other databases may vary.

Infallible on all supported targets (the usize→u64 conversion only widens).

pub fn estimate_storage_size_json<T>( &self, col: u32, key: &[u8], value: &T, ) -> VeilidAPIResult<u64>

where T: Serialize,

Estimate the storage size for a table entry if it is json encoded

Errors with VeilidAPIError::Internal if value fails to JSON-serialize.

pub async fn get_keys(&self, col: u32) -> VeilidAPIResult<Vec<Vec<u8>>>

Get the list of keys in a column of the TableDB

Blocks on on-disk reads.

Errors with VeilidAPIError::Generic if col is at or above the opened column count, if the backing-store read fails, or if a stored key fails to decompress (wrong device encryption key or corrupt data).

pub async fn get_key_count(&self, col: u32) -> VeilidAPIResult<u64>

Get the number of keys in a column of the TableDB

Blocks on on-disk reads.

Errors with VeilidAPIError::Generic if col is at or above the opened column count or the backing-store read fails.

pub fn transact(&self) -> TableDBTransaction

Start a TableDB write transaction. The transaction object must be committed or rolled back before dropping.

Returns a handle whose commit or rollback the caller must call; dropping it uncompleted logs an error and silently discards the writes.

pub async fn store( &self, col: u32, key: &[u8], value: &[u8], ) -> VeilidAPIResult<()>

Store a key with a value in a column in the TableDB. Performs a single transaction immediately.

Blocks on the on-disk write.

Errors with VeilidAPIError::Generic if col is at or above the opened column count or the backing-store write fails.

pub async fn store_json<T>( &self, col: u32, key: &[u8], value: &T, ) -> VeilidAPIResult<()>

where T: Serialize,

Store a key in json format with a value in a column in the TableDB. Performs a single transaction immediately.

Blocks on the on-disk write.

Errors with VeilidAPIError::Internal if value fails to JSON-serialize, otherwise the same errors as store.

pub async fn load( &self, col: u32, key: &[u8], ) -> VeilidAPIResult<Option<Vec<u8>>>

Read a key from a column in the TableDB immediately.

Blocks on the on-disk read.

Returns Ok(None) if the key is absent. Errors with VeilidAPIError::Generic if col is at or above the opened column count, if the backing-store read fails, or if the stored value fails to decompress (wrong device encryption key or corrupt data).

pub async fn load_json<T>( &self, col: u32, key: &[u8], ) -> VeilidAPIResult<Option<T>>

where T: for<'de> Deserialize<'de>,

Read an serde-json key from a column in the TableDB immediately

Blocks on the on-disk read.

Errors with VeilidAPIError::Internal if the stored value fails to JSON-deserialize into T, otherwise the same errors as load.

pub async fn delete( &self, col: u32, key: &[u8], ) -> VeilidAPIResult<Option<Vec<u8>>>

Delete key with from a column in the TableDB

Blocks on the on-disk write.

Returns Ok(None) if the key was absent. Errors with VeilidAPIError::Generic if col is at or above the opened column count, if the backing-store delete fails, or if the prior value fails to decompress (wrong device encryption key or corrupt data).

pub async fn delete_json<T>( &self, col: u32, key: &[u8], ) -> VeilidAPIResult<Option<T>>

where T: for<'de> Deserialize<'de>,

Delete serde-json key with from a column in the TableDB

Blocks on the on-disk write.

Errors with VeilidAPIError::Internal if the prior value fails to JSON-deserialize into T, otherwise the same errors as delete.

Trait Implementations

impl Clone for TableDB

fn clone(&self) -> TableDB

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableDB

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

Formats the value using the given formatter.