Struct arrow_array::builder::GenericByteRunBuilder

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

Array builder for RunArray for String and Binary types.

Example:

let mut builder =
GenericByteRunBuilder::<Int16Type, BinaryType>::new();
builder.append_value(b"abc");
builder.append_value(b"abc");
builder.append_null();
builder.append_value(b"def");
let array = builder.finish();

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

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: &BinaryArray = as_generic_binary_array(av.as_ref());

assert_eq!(ava.value(0), b"abc");
assert_eq!(ava.value(2), b"def");

Implementations

impl<R, V> GenericByteRunBuilder<R, V>where
    R: ArrowPrimitiveType,
    V: ByteArrayType,

pub fn new() -> Self

Creates a new GenericByteRunBuilder

pub fn with_capacity(capacity: usize, data_capacity: usize) -> Self

Creates a new GenericByteRunBuilder with the provided capacity

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

impl<R, V> GenericByteRunBuilder<R, V>where
    R: RunEndIndexType,
    V: ByteArrayType,

pub fn append_option(&mut self, input_value: Option<impl AsRef<V::Native>>)

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

pub fn append_value(&mut self, input_value: impl AsRef<V::Native>)

Appends value to the logical array encoded by the RunArray.

pub fn append_null(&mut self)

Appends null to the logical array encoded by the RunArray.

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 GenericByteRunBuilder<R, V>where
    R: RunEndIndexType,
    V: ByteArrayType,

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 GenericByteRunBuilder<R, V>where
    R: ArrowPrimitiveType + Debug,
    V: ByteArrayType + Debug,

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

Formats the value using the given formatter.

impl<R, V> Default for GenericByteRunBuilder<R, V>where
    R: ArrowPrimitiveType,
    V: ByteArrayType,

fn default() -> Self

Returns the “default value” for a type.