Struct Table 

pub struct Table<T>
where
    T: Serialize + for<'de> Deserialize<'de> + Clone,
{ /* private fields */ }

A Row-based Store

Table provides a record-oriented storage abstraction for entries in a subtree, similar to a database table with automatic primary key generation.

Features

• Automatically generates UUIDv4 primary keys for new records
• Provides CRUD operations (Create, Read, Update, Delete) for record-based data
• Supports searching across all records with a predicate function

Type Parameters

• T: The record type to be stored, which must be serializable, deserializable, and cloneable

This abstraction simplifies working with collections of similarly structured data by handling the details of:

• Primary key generation and management
• Serialization/deserialization of records
• Storage within the underlying CRDT (Doc)

Implementations

impl<T> Table<T>

where T: Serialize + for<'de> Deserialize<'de> + Clone + Send + Sync,

pub async fn get(&self, key: impl AsRef<str>) -> Result<T>

Retrieves a row from the Table by its primary key.

This method first checks for the record in the current transaction’s local changes, and if not found, retrieves it from the persistent state.

Arguments

• key - The primary key (UUID string) of the record to retrieve

Returns

• Ok(T) - The retrieved record if found
• Err(Error::NotFound) - If no record exists with the given key

Errors

Returns an error if:

• The record doesn’t exist (Error::NotFound)
• There’s a serialization/deserialization error

pub async fn insert(&self, row: T) -> Result<String>

Inserts a new row into the Table and returns its generated primary key.

This method:

1. Generates a new UUIDv4 as the primary key
2. Serializes the record
3. Stores it in the local transaction

Arguments

• row - The record to insert

Returns

• Ok(String) - The generated UUID primary key as a string

Errors

Returns an error if there’s a serialization error or the operation fails

pub async fn set(&self, key: impl AsRef<str>, row: T) -> Result<()>

Updates an existing row in the Table with a new value.

This method completely replaces the existing record with the provided one. If the record doesn’t exist yet, it will be created with the given key.

Arguments

• key - The primary key of the record to update
• row - The new record value

Returns

• Ok(()) - If the update was successful

Errors

Returns an error if there’s a serialization error or the operation fails

pub async fn delete(&self, key: impl AsRef<str>) -> Result<bool>

Deletes a row from the Table by its primary key.

This method marks the record as deleted using CRDT tombstone semantics, ensuring the deletion is properly synchronized across distributed nodes.

Arguments

• key - The primary key of the record to delete

Returns

• Ok(true) - If a record existed and was deleted
• Ok(false) - If no record existed with the given key

Errors

Returns an error if there’s a serialization error or the operation fails

pub async fn search( &self, query: impl Fn(&T) -> bool, ) -> Result<Vec<(String, T)>>

Searches for rows matching a predicate function.

Arguments

• query - A function that takes a reference to a record and returns a boolean

Returns

• Ok(Vec<(String, T)>) - A vector of (primary_key, record) pairs that match the predicate

Errors

Returns an error if there’s a serialization error or the operation fails

Trait Implementations

impl<T> Registered for Table<T>

where T: Serialize + for<'de> Deserialize<'de> + Clone,

fn type_id() -> &'static str

Returns a unique identifier for this type.

fn supports_type_id(type_id: &str) -> bool

Check if this type supports loading from a stored type_id.

impl<T> Store for Table<T>

where T: Serialize + for<'de> Deserialize<'de> + Clone + Send + Sync,

type Data = Doc

The CRDT data type used for local (staged) data in this store.

fn new<'life0, 'async_trait>( txn: &'life0 Transaction, subtree_name: String, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Creates a new Store handle associated with a specific transaction.

fn name(&self) -> &str

Returns the name of this subtree.

fn transaction(&self) -> &Transaction

Returns a reference to the transaction this Store is associated with.

fn default_config() -> Doc

Returns the default configuration for this Store type as a Doc.

fn init<'life0, 'async_trait>( txn: &'life0 Transaction, subtree_name: String, ) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Initializes a new subtree and registers it in the _index.

fn get_config<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Doc>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Gets the current configuration for this Store from the _index subtree.

fn set_config<'life0, 'async_trait>( &'life0 self, config: Doc, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sets the configuration for this Store in the _index subtree.

fn get_height_strategy<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<HeightStrategy>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Gets the height strategy for this Store from the _index subtree.

fn set_height_strategy<'life0, 'async_trait>( &'life0 self, strategy: Option<HeightStrategy>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sets the height strategy for this Store in the _index subtree.

fn local_data(&self) -> Result<Option<Self::Data>>

Returns the local (staged) data for this store from the current transaction.