Struct TableDB 

pub struct TableDB { /* private fields */ }

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

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.

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.

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

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

Get the list of keys in a column of the TableDB

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

Get the number of keys in a column of the TableDB

pub fn transact(&self) -> TableDBTransaction

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

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.

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.

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

Read a key from a column in the TableDB immediately.

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

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

Delete key with from a column in the TableDB

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

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.