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_dense_without_column_id(&self, bytes: &[u8]) -> Result<Vec<Value>>

Decode primary key values from bytes without column id.

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

Returns the field at pos.

Panics

Panics if pos is out of bounds.

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 offsets buffer is how many bytes to skip in order to read value at pos.

pub fn estimated_size(&self) -> usize

pub fn num_fields(&self) -> usize

Trait Implementations

impl Clone for DensePrimaryKeyCodec

fn clone(&self) -> DensePrimaryKeyCodec

Returns a copy 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 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.