Struct CanonicalRowKey 

pub struct CanonicalRowKey { /* private fields */ }

Canonical lexicographically ordered primary row key.

Implementations

impl CanonicalRowKey

pub const fn new(table_id: u32, row_id: u64) -> Self

Builds a canonical primary key from a table and row identity.

pub fn decode(encoded: &[u8]) -> Result<Self, RowKeyRangeError>

Decodes exactly the canonical primary-row-key format.

pub fn encode(self) -> Vec<u8>

Serializes to the canonical bytes shared by SQL and cluster storage.

pub const fn table_id(self) -> u32

Returns the stable table component of the key.

pub const fn row_id(self) -> u64

Returns the stable row component of the key.

pub fn table_prefix(table_id: u32) -> Vec<u8>

Returns the lexicographic prefix of every primary row key for a table.

pub fn table_prefix_end(table_id: u32) -> Vec<u8>

Returns the first byte sequence lexicographically after every row key with this table prefix. It remains valid even for u32::MAX.

Trait Implementations

impl Clone for CanonicalRowKey

fn clone(&self) -> CanonicalRowKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CanonicalRowKey

impl Debug for CanonicalRowKey

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

Formats the value using the given formatter.

impl Eq for CanonicalRowKey

impl Hash for CanonicalRowKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CanonicalRowKey

fn cmp(&self, other: &CanonicalRowKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CanonicalRowKey

fn eq(&self, other: &CanonicalRowKey) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for CanonicalRowKey

fn partial_cmp(&self, other: &CanonicalRowKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for CanonicalRowKey