Struct OrderedCodec 

pub struct OrderedCodec { /* private fields */ }

Order-preserving codec for index keys.

Stateless: can be shared and reused freely.

Implementations

impl OrderedCodec

pub const fn new() -> Self

pub const fn version(&self) -> u8

pub fn supports_ordered_key(data_type: &DataType) -> bool

Whether OrderedCodec can encode values of the given type as an ordered index key.

This is the single source of truth for the set of indexable types: it must stay in sync with OrderedCodec::encode_value. A type that returns false here is rejected at index-creation time and would also be rejected at encode time.

pub fn encode(&self, value: &Value) -> Result<Vec<u8>, StorageError>

Encode a single Value into order-preserving bytes.

pub fn encode_null_last(&self, value: &Value) -> Result<Vec<u8>, StorageError>

Encode value with null-last placement (sorts after all non-null values).

pub fn decode(&self, bytes: &[u8]) -> Result<Value, StorageError>

Decode a single Value from bytes produced by [encode].

pub fn decode_value_inner( &self, bytes: &[u8], ) -> Result<(Value, usize), StorageError>

Decode the first value; return the value and bytes consumed.

pub fn encode_composite( &self, values: &[&Value], entity: Option<&EntityRef>, null_last: bool, ) -> Result<Vec<u8>, StorageError>

Encode a composite index key from multiple values and an optional entity tie-breaker.

pub fn encode_entity( &self, entity: &EntityRef, buf: &mut Vec<u8>, ) -> Result<(), StorageError>

Encode an entity reference (Vertex or Edge) as a tie-breaker.

pub fn decode_entity_bytes( &self, bytes: &[u8], ) -> Result<(EntityRef, usize), StorageError>

Decode an entity reference from bytes.

pub fn prefix_upper_bound(prefix: &[u8]) -> Vec<u8>

Compute the prefix upper bound for range scanning.

Increments the last byte of the prefix (with carry) to produce an exclusive upper bound for a tight prefix range.

pub fn prefix_bounds( &self, value: &Value, ) -> Result<(Vec<u8>, Vec<u8>), StorageError>

Return tight (inclusive lower, exclusive upper) byte bounds for a prefix scan over the given value.

For fixed-length types the bounds are the encoded value and its [prefix_upper_bound]. For variable-length types (String, Blob) the lower bound is the full encoded value (including terminator) and the upper bound is the tag followed by prefix_upper_bound(data_bytes) — this correctly covers all values whose encoded prefix equals the given value’s encoding while excluding the next value in order.

Trait Implementations

impl Clone for OrderedCodec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OrderedCodec

impl Debug for OrderedCodec

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

Formats the value using the given formatter.

impl Default for OrderedCodec

fn default() -> Self

Returns the “default value” for a type.