Struct ListViewBuilder 

pub struct ListViewBuilder<O: IntegerPType, S: IntegerPType> { /* private fields */ }

A builder for creating ListViewArray instances, parameterized by the IntegerPType of the offsets and the sizes builders.

This builder tracks both offsets and sizes using potentially different integer types for memory efficiency. For example, you might use u64 for offsets but only u8 for sizes if your lists are small.

Any combination of IntegerPType types are valid, as long as the type of sizes can fit into the type of offsets.

Implementations

impl<O: IntegerPType, S: IntegerPType> ListViewBuilder<O, S>

pub fn new(element_dtype: Arc<DType>, nullability: Nullability) -> Self

Creates a new ListViewBuilder with a capacity of DEFAULT_BUILDER_CAPACITY.

pub fn with_capacity( element_dtype: Arc<DType>, nullability: Nullability, elements_capacity: usize, capacity: usize, ) -> Self

Create a new ListViewArray builder with a with the given capacity, as well as an initial capacity for the elements builder (since we cannot know that ahead of time solely based on the outer array capacity).

Panics

Panics if the size type S cannot fit within the offset type O.

pub fn append_value(&mut self, value: ListScalar<'_>) -> VortexResult<()>

Append a list of values to the builder.

This method extends the value builder with the provided values and records the offset and size of the new list.

pub fn finish_into_listview(&mut self) -> ListViewArray

Finishes the builder directly into a ListViewArray.

pub fn element_dtype(&self) -> &DType

The DType of the inner elements. Note that this is not the same as the DType of the outer FixedSizeList.

Trait Implementations

impl<O: IntegerPType, S: IntegerPType> ArrayBuilder for ListViewBuilder<O, S>

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 reserve_exact(&mut self, capacity: usize)

Allocate space for extra additional items

unsafe fn set_validity_unchecked(&mut self, validity: Mask)

override validity with the one provided, without checking lengths

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.

fn set_validity(&mut self, validity: Mask)

Override builders validity with the one provided.