Struct PrimitiveBuilder 

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

The builder for building a PrimitiveArray, parametrized by the PType.

Implementations

impl<T: NativePType> PrimitiveBuilder<T>

pub fn new(nullability: Nullability) -> Self

Creates a new PrimitiveBuilder with a capacity of DEFAULT_BUILDER_CAPACITY.

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

Creates a new PrimitiveBuilder with the given capacity.

pub fn append_value(&mut self, value: T)

Appends a primitive value to the builder.

pub fn values(&self) -> &[T]

Returns the raw primitive values in this builder as a slice.

pub fn uninit_range(&mut self, len: usize) -> UninitRange<'_, T>

Create a new handle to the next len uninitialized values in the builder.

All reads/writes through the handle to the values buffer or the validity buffer will operate on indices relative to the start of the range.

Panics

Panics if len is 0 or if the current length of the builder plus len would exceed the capacity of the builder’s memory.

Example

use std::mem::MaybeUninit;
use vortex_array::builders::{ArrayBuilder, PrimitiveBuilder};
use vortex_dtype::Nullability;

// Create a new builder.
let mut builder: PrimitiveBuilder<i32> =
    PrimitiveBuilder::with_capacity(Nullability::NonNullable, 5);

// Populate the values.
let mut uninit_range = builder.uninit_range(5);
uninit_range.copy_from_slice(0, &[0, 1, 2, 3, 4]);

// SAFETY: We have initialized all 5 values in the range, and since the array builder is
// non-nullable, we don't need to set any null bits.
unsafe { uninit_range.finish(); }

let built = builder.finish_into_primitive();

assert_eq!(built.as_slice::<i32>(), &[0i32, 1, 2, 3, 4]);

pub fn finish_into_primitive(&mut self) -> PrimitiveArray

Finishes the builder directly into a PrimitiveArray.

pub fn extend_with_iterator( &mut self, iter: impl IntoIterator<Item = T>, mask: Mask, )

Extends the primitive array with an iterator.

Trait Implementations

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

fn as_any(&self) -> &dyn Any

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

fn dtype(&self) -> &DType

fn len(&self) -> usize

fn append_zeros(&mut self, n: usize)

Appends n “zero” values to the array.

unsafe fn append_nulls_unchecked(&mut self, n: usize)

The inner part of append_nulls.

fn append_scalar(&mut self, scalar: &Scalar) -> VortexResult<()>

A generic function to append a scalar to the builder.

unsafe fn extend_from_array_unchecked(&mut self, array: &dyn Array)

The inner part of extend_from_array.

fn ensure_capacity(&mut self, capacity: usize)

Ensure that the builder can hold at least capacity number of items

fn set_validity(&mut self, validity: Mask)

Override builders validity with the one provided.

fn finish(&mut self) -> ArrayRef

Constructs an Array from the builder components.

fn finish_into_canonical(&mut self) -> Canonical

Constructs a canonical array directly from the builder.

fn is_empty(&self) -> bool

fn append_zero(&mut self)

Append a “zero” value to the array.

fn append_null(&mut self)

Append a “null” value to the array.

fn append_nulls(&mut self, n: usize)

Appends n “null” values to the array.

fn append_default(&mut self)

Appends a default value to the array.

fn append_defaults(&mut self, n: usize)

Appends n default values to the array.

fn extend_from_array(&mut self, array: &dyn Array)

Extends the array with the provided array, canonicalizing if necessary.