Struct arrow_array::builder::PrimitiveRunBuilder

pub struct PrimitiveRunBuilder<R, V>where
    R: RunEndIndexType,
    V: ArrowPrimitiveType,{ /* private fields */ }

Array builder for RunArray that encodes primitive values.

Example:

let mut builder =
PrimitiveRunBuilder::<Int16Type, UInt32Type>::new();
builder.append_value(1234);
builder.append_value(1234);
builder.append_value(1234);
builder.append_null();
builder.append_value(5678);
builder.append_value(5678);
let array = builder.finish();

assert_eq!(
    array.run_ends(),
    &Int16Array::from(vec![Some(3), Some(4), Some(6)])
);

let av = array.values();

assert!(!av.is_null(0));
assert!(av.is_null(1));
assert!(!av.is_null(2));

// Values are polymorphic and so require a downcast.
let ava: &UInt32Array = as_primitive_array::<UInt32Type>(av.as_ref());

assert_eq!(ava, &UInt32Array::from(vec![Some(1234), None, Some(5678)]));

Implementations

impl<R, V> PrimitiveRunBuilder<R, V>where
    R: RunEndIndexType,
    V: ArrowPrimitiveType,

pub fn new() -> Self

Creates a new PrimitiveRunBuilder

pub fn with_capacity(capacity: usize) -> Self

Creates a new PrimitiveRunBuilder with the provided capacity

capacity: the expected number of run-end encoded values.

impl<R, V> PrimitiveRunBuilder<R, V>where
    R: RunEndIndexType,
    V: ArrowPrimitiveType,

pub fn append_option(&mut self, value: Option<V::Native>)

Appends optional value to the logical array encoded by the RunArray.

pub fn append_value(&mut self, value: V::Native)

Appends value to the logical array encoded by the run-ends array.

pub fn append_null(&mut self)

Appends null to the logical array encoded by the run-ends array.

pub fn finish(&mut self) -> RunArray<R>

Creates the RunArray and resets the builder. Panics if RunArray cannot be built.

pub fn finish_cloned(&self) -> RunArray<R>

Creates the RunArray and without resetting the builder. Panics if RunArray cannot be built.

Trait Implementations

impl<R, V> ArrayBuilder for PrimitiveRunBuilder<R, V>where
    R: RunEndIndexType,
    V: ArrowPrimitiveType,

fn as_any(&self) -> &dyn Any

Returns the builder as a non-mutable Any reference.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the builder as a mutable Any reference.

fn into_box_any(self: Box<Self>) -> Box<dyn Any>

Returns the boxed builder as a box of Any.

fn len(&self) -> usize

Returns the length of logical array encoded by the eventual runs array.

fn is_empty(&self) -> bool

Returns whether the number of array slots is zero

fn finish(&mut self) -> ArrayRef

Builds the array and reset this builder.

fn finish_cloned(&self) -> ArrayRef

Builds the array without resetting the builder.

impl<R, V> Debug for PrimitiveRunBuilder<R, V>where
    R: RunEndIndexType + Debug,
    V: ArrowPrimitiveType + Debug,
    V::Native: Debug,

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

Formats the value using the given formatter.

impl<R, V> Default for PrimitiveRunBuilder<R, V>where
    R: RunEndIndexType,
    V: ArrowPrimitiveType,

fn default() -> Self

Returns the “default value” for a type.