Struct OnPairMetadata 

pub struct OnPairMetadata {
    pub uncompressed_lengths_ptype: i32,
    pub bits: u32,
    pub dict_size: u32,
    pub total_tokens: u64,
    pub dict_offsets_ptype: i32,
    pub codes_ptype: i32,
    pub codes_offsets_ptype: i32,
}

Wire-format metadata persisted alongside the OnPair buffer + slot children.

On disk the layout is FSST-shape:

• Buffer 0 — dict_bytes: the dictionary blob built by the OnPair trainer, padded with onpair::MAX_TOKEN_SIZE trailing zero bytes so the over-copy decoder can read 16 bytes past the last token.
• Slots — see OnPairSlots.

The four integer slot children flow through the standard compress_child pipeline (see vortex-btrblocks::schemes::string::OnPairScheme), so any encoding registered with the compressor can re-encode them — exactly the same shape as FSST’s codes VarBinArray.

Fields

uncompressed_lengths_ptype: i32

Width of the per-row primitive uncompressed_lengths child.

bits: u32

Bits-per-token the column was compressed with (9..=16). Every value in the codes child only uses its low bits bits.

dict_size: u32

Number of dictionary tokens. dict_offsets has length dict_size + 1. Bounded by 2^bits ≤ 2^16 = 65_536, so u32 is comfortably wide.

total_tokens: u64

Total number of tokens across all rows. codes has this length; codes_offsets.last() == total_tokens.

dict_offsets_ptype: i32

PType of the dict_offsets slot child (defaults to U32, may be narrowed to U16/U8 by the cascading compressor when values fit).

codes_ptype: i32

PType of the codes slot child (typically U16, may be narrowed to U8 when bits <= 8).

codes_offsets_ptype: i32

PType of the codes_offsets slot child.

Implementations

impl OnPairMetadata

pub fn uncompressed_lengths_ptype(&self) -> PType

Returns the enum value of uncompressed_lengths_ptype, or the default if the field is set to an invalid enum value.

pub fn set_uncompressed_lengths_ptype(&mut self, value: PType)

Sets uncompressed_lengths_ptype to the provided enum value.

pub fn dict_offsets_ptype(&self) -> PType

Returns the enum value of dict_offsets_ptype, or the default if the field is set to an invalid enum value.

pub fn set_dict_offsets_ptype(&mut self, value: PType)

Sets dict_offsets_ptype to the provided enum value.

pub fn codes_ptype(&self) -> PType

Returns the enum value of codes_ptype, or the default if the field is set to an invalid enum value.

pub fn set_codes_ptype(&mut self, value: PType)

Sets codes_ptype to the provided enum value.

pub fn codes_offsets_ptype(&self) -> PType

Returns the enum value of codes_offsets_ptype, or the default if the field is set to an invalid enum value.

pub fn set_codes_offsets_ptype(&mut self, value: PType)

Sets codes_offsets_ptype to the provided enum value.

impl OnPairMetadata

pub fn get_uncompressed_lengths_ptype(&self) -> VortexResult<PType>

Trait Implementations

impl Clone for OnPairMetadata

fn clone(&self) -> OnPairMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OnPairMetadata

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

Formats the value using the given formatter.

impl Default for OnPairMetadata

fn default() -> Self

Returns the “default value” for a type.

impl Message for OnPairMetadata

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.