Struct DecimalBuilder 

pub struct DecimalBuilder { /* private fields */ }

The builder for building a DecimalArray.

The output will be a new DecimalArray holding values of T. Any value that is a valid decimal type can be appended to the builder and it will be immediately coerced into the target type.

Implementations

impl DecimalBuilder

pub fn new<T: NativeDecimalType>( precision: u8, scale: i8, nullability: Nullability, ) -> Self

Creates a new DecimalBuilder with a capacity of DEFAULT_BUILDER_CAPACITY.

pub fn with_capacity<T: NativeDecimalType>( capacity: usize, decimal: DecimalDType, nullability: Nullability, ) -> Self

Creates a new DecimalBuilder with the given capacity.

pub fn append_value<V: NativeDecimalType>(&mut self, value: V)

Appends a decimal value to the builder.

pub fn append_option<V: NativeDecimalType>(&mut self, value: Option<V>)

Appends an optional decimal value to the builder.

If the value is Some, it appends the decimal 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_decimal(&mut self) -> DecimalArray

Finishes the builder directly into a DecimalArray.

pub fn decimal_dtype(&self) -> &DecimalDType

The DecimalDType of this builder.

Trait Implementations

impl ArrayBuilder for DecimalBuilder

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.