Struct FixedSizeListBuilder 

pub struct FixedSizeListBuilder { /* private fields */ }

The builder for building a FixedSizeListArray.

Implementations

impl FixedSizeListBuilder

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

Creates a new FixedSizeListBuilder with a capacity of DEFAULT_BUILDER_CAPACITY.

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

Creates a new FixedSizeListBuilder with the given capacity.

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

Appends a fixed-size list value to the builder.

Note that a ListScalar can represent both a ListArray scalar and a FixedSizeListArray scalar (since a single list cannot know the size of other lists in fixed-size list arrays without accompanying metadata).

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

Appends an optional fixed-size list value to the builder.

If the value is Some, it appends the list value. 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_fixed_size_list(&mut self) -> FixedSizeListArray

Finishes the builder directly into a FixedSizeListArray.

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.

pub fn list_size(&self) -> u32

The size of each fixed-size list.

Trait Implementations

impl ArrayBuilder for FixedSizeListBuilder

fn append_zeros(&mut self, n: usize)

We define the “zero” value of a fixed-size list of size m to be a list of m zero values (where “zero value” is defined by the element DType).

We append n * m of these values to the underlying elements array.

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

We define the null value of a fixed-size list of size m to be a list of m placeholder values.

We append n * m default values to the underlying elements array.

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

This will increase the capacity if extending with this array would go past the original capacity.

fn as_any(&self) -> &dyn Any

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

fn dtype(&self) -> &DType

fn len(&self) -> usize

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.