Struct SortKey

pub struct SortKey(/* private fields */);

Opaque sort key encoded as bytes for lexicographic comparison.

The encoding ensures that database-level ORDER BY sort_key ASC produces the correct logical ordering. Use [SortKeyBuilder] to construct composite keys with mixed ascending/descending fields.

Database Storage

Store as BLOB (SQLite), BYTEA (Postgres), or raw bytes in NoSQL stores. Create an index on (partition, sort_key) for efficient range scans.

Implementations

impl SortKey

pub fn as_bytes(&self) -> &[u8]

Returns the raw bytes for database storage.

pub fn from_bytes(bytes: Vec<u8>) -> Self

Constructs a sort key from raw bytes (for database retrieval).

pub fn builder() -> SortKeyBuilder

Creates a builder for composite sort keys.

pub fn u32_asc(n: u32) -> Self

Creates a sort key from a single u32, ascending order.

pub fn u64_desc(n: u64) -> Self

Creates a sort key from a single u64, descending order.

Trait Implementations

impl Clone for SortKey

fn clone(&self) -> SortKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SortKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SortKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SortKey

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 SortKey

fn cmp(&self, other: &SortKey) -> 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 SortKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SortKey

fn partial_cmp(&self, other: &SortKey) -> 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 Serialize for SortKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SortKey

impl StructuralPartialEq for SortKey