Struct arrow_array::builder::PrimitiveBuilder

pub struct PrimitiveBuilder<T: ArrowPrimitiveType> { /* private fields */ }

Array builder for fixed-width primitive types

Implementations

impl<T: ArrowPrimitiveType> PrimitiveBuilder<T>

pub fn new() -> Self

Creates a new primitive array builder

pub fn with_capacity(capacity: usize) -> Self

Creates a new primitive array builder with capacity no of items

pub fn new_from_buffer(
    values_buffer: MutableBuffer,
    null_buffer: Option<MutableBuffer>
) -> Self

Creates a new primitive array builder from buffers

pub fn capacity(&self) -> usize

Returns the capacity of this builder measured in slots of type T

pub fn append_value(&mut self, v: T::Native)

Appends a value of type T into the builder

pub fn append_null(&mut self)

Appends a null slot into the builder

pub fn append_nulls(&mut self, n: usize)

Appends n no. of null’s into the builder

pub fn append_option(&mut self, v: Option<T::Native>)

Appends an Option<T> into the builder

pub fn append_slice(&mut self, v: &[T::Native])

Appends a slice of type T into the builder

pub fn append_values(&mut self, values: &[T::Native], is_valid: &[bool])

Appends values from a slice of type T and a validity boolean slice

pub unsafe fn append_trusted_len_iter(
    &mut self,
    iter: impl IntoIterator<Item = T::Native>
)

Appends values from a trusted length iterator.

Safety

This requires the iterator be a trusted length. This could instead require the iterator implement TrustedLen once that is stabilized.

pub fn finish(&mut self) -> PrimitiveArray<T>

Builds the PrimitiveArray and reset this builder.

pub fn finish_cloned(&self) -> PrimitiveArray<T>

Builds the PrimitiveArray without resetting the builder.

pub fn values_slice(&self) -> &[T::Native]

Returns the current values buffer as a slice

pub fn values_slice_mut(&mut self) -> &mut [T::Native]

Returns the current values buffer as a mutable slice

pub fn validity_slice(&self) -> Option<&[u8]>

Returns the current values buffer as a slice

pub fn validity_slice_mut(&mut self) -> Option<&mut [u8]>

Returns the current values buffer as a mutable slice

pub fn slices_mut(&mut self) -> (&mut [T::Native], Option<&mut [u8]>)

Returns the current values buffer and null buffer as a slice

Trait Implementations

impl<T: ArrowPrimitiveType> ArrayBuilder for PrimitiveBuilder<T>

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 number of array slots in the builder

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<T: Debug + ArrowPrimitiveType> Debug for PrimitiveBuilder<T>where
    T::Native: Debug,

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

Formats the value using the given formatter.

impl<T: ArrowPrimitiveType> Default for PrimitiveBuilder<T>

fn default() -> Self

Returns the “default value” for a type.