Struct ListBuilder 

pub struct ListBuilder<O: NativePType> { /* private fields */ }

The builder for building a ListArray, parametrized by the PType of the offsets buffer.

Implementations

impl<O: OffsetPType> ListBuilder<O>

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

Creates a new ListBuilder with a capacity of DEFAULT_BUILDER_CAPACITY.

pub fn with_capacity( value_dtype: Arc<DType>, nullability: Nullability, index_capacity: usize, ) -> Self

Creates a new ListBuilder with the given capacity.

Notes

The number of indices is one more than the number of lists in the array!

See also: ListBuilder::with_values_and_index_capacity.

pub fn with_values_and_index_capacity( value_dtype: Arc<DType>, nullability: Nullability, values_capacity: usize, index_capacity: usize, ) -> Self

Create a ListBuilder with the specified capacity for indices and values.

Notes

The number of indices is one more than the number of lists in the array!

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

Appends a list value to the builder.

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

Appends an optional list value to the builder.

If the value is Some, it appends the list. If the value is None, it appends a null.

Panics

This method will panic if the input is None and the builder is non-nullable.

pub fn finish_into_list(&mut self) -> ListArray

Finishes the builder directly into a ListArray.

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 List.

Trait Implementations

impl<O: OffsetPType> ArrayBuilder for ListBuilder<O>

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.

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 append_scalar(&mut self, scalar: &Scalar) -> VortexResult<()>

A generic function to append a scalar to the builder.

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

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