Trait radix_substate_store_interface::db_key_mapper::DatabaseKeyMapper

pub trait DatabaseKeyMapper {
    // Required methods
    fn to_db_node_key(node_id: &NodeId) -> DbNodeKey;
    fn from_db_node_key(db_node_key: &DbNodeKey) -> NodeId;
    fn to_db_partition_num(partition_num: PartitionNumber) -> DbPartitionNum;
    fn from_db_partition_num(
        db_partition_num: DbPartitionNum
    ) -> PartitionNumber;
    fn field_to_db_sort_key(field_key: &FieldKey) -> DbSortKey;
    fn field_from_db_sort_key(db_sort_key: &DbSortKey) -> FieldKey;
    fn map_to_db_sort_key(map_key: &MapKey) -> DbSortKey;
    fn map_from_db_sort_key(db_sort_key: &DbSortKey) -> MapKey;
    fn sorted_to_db_sort_key(sorted_key: &SortedKey) -> DbSortKey;
    fn sorted_from_db_sort_key(db_sort_key: &DbSortKey) -> SortedKey;

    // Provided methods
    fn to_db_partition_key(
        node_id: &NodeId,
        partition_num: PartitionNumber
    ) -> DbPartitionKey { ... }
    fn from_db_partition_key(
        partition_key: &DbPartitionKey
    ) -> (NodeId, PartitionNumber) { ... }
    fn to_db_sort_key(key: &SubstateKey) -> DbSortKey { ... }
    fn from_db_sort_key<K: SubstateKeyContent + 'static>(
        db_sort_key: &DbSortKey
    ) -> SubstateKey { ... }
}

A mapper between the business ReNode / Partition / Substate IDs and database keys.

Required Methods

fn to_db_node_key(node_id: &NodeId) -> DbNodeKey

Converts the given Node ID to the database Node key.

fn from_db_node_key(db_node_key: &DbNodeKey) -> NodeId

Converts the database Node key back to ReNode ID.

fn to_db_partition_num(partition_num: PartitionNumber) -> DbPartitionNum

Converts the given Partition number to the database Partition number.

fn from_db_partition_num(db_partition_num: DbPartitionNum) -> PartitionNumber

Converts the database Partition number back to a Partition number.

fn field_to_db_sort_key(field_key: &FieldKey) -> DbSortKey

fn field_from_db_sort_key(db_sort_key: &DbSortKey) -> FieldKey

fn map_to_db_sort_key(map_key: &MapKey) -> DbSortKey

fn map_from_db_sort_key(db_sort_key: &DbSortKey) -> MapKey

fn sorted_to_db_sort_key(sorted_key: &SortedKey) -> DbSortKey

fn sorted_from_db_sort_key(db_sort_key: &DbSortKey) -> SortedKey

Provided Methods

fn to_db_partition_key( node_id: &NodeId, partition_num: PartitionNumber ) -> DbPartitionKey

Converts the given Node ID and Partition number to the database partition’s key.

fn from_db_partition_key( partition_key: &DbPartitionKey ) -> (NodeId, PartitionNumber)

Converts database partition’s key back to ReNode ID and Partition number.

fn to_db_sort_key(key: &SubstateKey) -> DbSortKey

Converts the given SubstateKey to the database’s sort key. This is a convenience method, which simply unwraps the SubstateKey and maps any specific type found inside (see *_to_db_sort_key() family).

fn from_db_sort_key<K: SubstateKeyContent + 'static>( db_sort_key: &DbSortKey ) -> SubstateKey

Converts the given database’s sort key to a SubstateKey. This is a convenience method, which simply wraps the type-specific result of an appropriate *_from_db_sort_key() method into a SubstateKey.

Object Safety

This trait is not object safe.

Implementors

impl DatabaseKeyMapper for SpreadPrefixKeyMapper