Struct DensePrimaryKeyCodec 

pub struct DensePrimaryKeyCodec {
    ordered_primary_key_columns: Arc<Vec<(ColumnId, SortField)>>,
}

A memory-comparable row [Value] encoder/decoder.

Fields

ordered_primary_key_columns: Arc<Vec<(ColumnId, SortField)>>

Primary key fields.

Implementations

impl DensePrimaryKeyCodec

pub fn new(metadata: &RegionMetadata) -> Self

pub fn with_fields(fields: Vec<(ColumnId, SortField)>) -> Self

fn encode_dense<'a, I>(&self, row: I, buffer: &mut Vec<u8>) -> Result<()>

where I: Iterator<Item = ValueRef<'a>>,

pub fn decode_dense(&self, bytes: &[u8]) -> Result<Vec<(ColumnId, Value)>>

Decode primary key values from bytes.

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

Counts complete fields in a key encoded with a prefix of this codec’s schema.

Dense keys contain neither column ids nor types: callers must ensure that existing fields have the same order and types. Only EOF between fields is accepted; truncated fields and bytes beyond the schema return an error. Field boundaries are checked in all builds; full value validation is only enabled in debug builds and this crate’s unit tests.

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

Decode primary key values from bytes without column id.

pub fn decode_dense_iter<'a>( &'a self, bytes: &'a [u8], ) -> impl Iterator<Item = Result<(ColumnId, Value)>> + 'a

Iterates over all source PK fields in schema order, checking each field’s encoded boundary before deserializing it. Stops after the first error.

Unlike positional access, this requires no offsets or value cache. Callers can consume each value immediately instead of retaining the entire key.

pub fn fields(&self) -> &[(ColumnId, SortField)]

Returns the column ids and sort fields in encoded primary-key order.

pub fn decode_dense_with( &self, bytes: &[u8], value_buf: &mut Vec<u8>, consume: impl FnMut(usize, ValueRef<'_>), ) -> Result<()>

Decodes all fields in source order into a consumer, checking boundaries. Strings borrow the reusable buffer for the duration of each callback, so materializing them into column builders needs no per-value owned string.

fn field_at(&self, pos: usize) -> &SortField

Returns the field at pos.

Panics

Panics if pos is out of bounds.

fn advance_to_value_at( &self, bytes: &[u8], pos: usize, offsets_buf: &mut Vec<usize>, deserializer: &mut Deserializer<&[u8]>, ) -> Result<usize>

Advances deserializer to the start of value at pos.

Returns the offset of the value at pos in bytes.

pub fn decode_value_at( &self, bytes: &[u8], pos: usize, offsets_buf: &mut Vec<usize>, ) -> Result<Value>

Decode value at pos in bytes.

The i-th element in the offsets buffer is the start of field i. The buffer must only be reused for the same encoded key and codec.

pub fn encoded_value_at<'a>( &self, bytes: &'a [u8], pos: usize, offsets_buf: &mut Vec<usize>, ) -> Result<&'a [u8]>

Returns the encoded bytes at pos in bytes.

The i-th element in the offsets buffer is the start of field i. The buffer must only be reused for the same encoded key and codec. Validates the framing up to this field, without validating or decoding later fields.

pub fn estimated_size(&self) -> usize

pub fn num_fields(&self) -> usize

Trait Implementations

impl Clone for DensePrimaryKeyCodec

fn clone(&self) -> DensePrimaryKeyCodec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DensePrimaryKeyCodec

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

Formats the value using the given formatter.

impl PrimaryKeyCodec for DensePrimaryKeyCodec

fn encode_key_value( &self, key_value: &KeyValue<'_>, buffer: &mut Vec<u8>, ) -> Result<()>

Encodes a key value to bytes.

fn encode_values( &self, values: &[(ColumnId, Value)], buffer: &mut Vec<u8>, ) -> Result<()>

Encodes values to bytes.

fn encode_value_refs( &self, values: &[(ColumnId, ValueRef<'_>)], buffer: &mut Vec<u8>, ) -> Result<()>

Encodes values to bytes.

fn estimated_size(&self) -> Option<usize>

Returns the estimated size of the primary key.

fn num_fields(&self) -> Option<usize>

Returns the number of fields in the primary key.

fn encoding(&self) -> PrimaryKeyEncoding

Returns the encoding type of the primary key.

fn as_dense(&self) -> Option<&DensePrimaryKeyCodec>

Returns the dense codec for schema-aware positional access, if applicable.

fn primary_key_filter( &self, metadata: &RegionMetadataRef, filters: Arc<Vec<SimpleFilterEvaluator>>, ) -> Box<dyn PrimaryKeyFilter>

Returns a primary key filter factory.

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

Decodes the primary key from the given bytes.

fn decode_leftmost(&self, bytes: &[u8]) -> Result<Option<Value>>

Decode the leftmost value from bytes.

impl PrimaryKeyCodecExt for DensePrimaryKeyCodec

fn encode_to_vec<'a, I>(&self, row: I, buffer: &mut Vec<u8>) -> Result<()>

where I: Iterator<Item = ValueRef<'a>>,

Encodes rows to specific vec.

fn encode<'a, I>(&self, row: I) -> Result<Vec<u8>>

where I: Iterator<Item = ValueRef<'a>>,

Encodes rows to bytes.