Trait radix_substate_store_interface::interface::SubstateDatabase

pub trait SubstateDatabase {
    // Required methods
    fn get_substate(
        &self,
        partition_key: &DbPartitionKey,
        sort_key: &DbSortKey
    ) -> Option<DbSubstateValue>;
    fn list_entries_from(
        &self,
        partition_key: &DbPartitionKey,
        from_sort_key: Option<&DbSortKey>
    ) -> Box<dyn Iterator<Item = PartitionEntry> + '_>;

    // Provided method
    fn list_entries(
        &self,
        partition_key: &DbPartitionKey
    ) -> Box<dyn Iterator<Item = PartitionEntry> + '_> { ... }
}

A read interface between Track and a database vendor.

Required Methods

fn get_substate( &self, partition_key: &DbPartitionKey, sort_key: &DbSortKey ) -> Option<DbSubstateValue>

Reads a substate value by its partition and sort key, or Option::None if missing.

fn list_entries_from( &self, partition_key: &DbPartitionKey, from_sort_key: Option<&DbSortKey> ) -> Box<dyn Iterator<Item = PartitionEntry> + '_>

Iterates over all entries of the given partition (starting either from the beginning, or from the given DbSortKey), in a lexicographical order (ascending) of the DbSortKeys. Note: If the exact given starting key does not exist, the iteration starts with its immediate successor.

Provided Methods

fn list_entries( &self, partition_key: &DbPartitionKey ) -> Box<dyn Iterator<Item = PartitionEntry> + '_>

Iterates over all entries of the given partition, in a lexicographical order (ascending) of the DbSortKeys. This is a convenience method, equivalent to Self::list_entries_from() with the starting key set to None.

Implementors