Struct RepDefBuilder

pub struct RepDefBuilder { /* private fields */ }

A structure used to collect validity buffers and offsets from arrow arrays and eventually create repetition and definition levels

As we are encoding the structural encoders are given this struct and will record the arrow information into it. Once we hit a leaf node we serialize the data into rep/def levels and write these into the page.

Implementations

impl RepDefBuilder

pub fn is_simple_validity(&self) -> bool

Returns true if there is only a single layer of definition

pub fn has_nulls(&self) -> bool

Return True if any layer has a validity bitmap

Return False if all layers are non-null (the def levels can be skipped in this case)

pub fn has_offsets(&self) -> bool

pub fn add_validity_bitmap(&mut self, validity: NullBuffer)

Registers a nullable validity bitmap

pub fn add_no_null(&mut self, len: usize)

Registers an all-valid validity layer

pub fn add_offsets<O: OffsetSizeTrait>( &mut self, offsets: OffsetBuffer<O>, validity: Option<NullBuffer>, ) -> bool

Adds a layer of offsets

Offsets are casted to a common type (i64) and also normalized. Null lists are always represented by a zero-length (identical) pair of offsets and so the caller should filter out any garbage items before encoding them. To assist with this the method will return true if any non-empty null lists were found.

pub fn serialize(builders: Vec<Self>) -> SerializedRepDefs

Converts the validity / offsets buffers that have been gathered so far into repetition and definition levels

Trait Implementations

impl Clone for RepDefBuilder

fn clone(&self) -> RepDefBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RepDefBuilder

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

Formats the value using the given formatter.

impl Default for RepDefBuilder

fn default() -> RepDefBuilder

Returns the “default value” for a type.