Struct arrow_array::builder::PrimitiveBuilder

source ·
pub struct PrimitiveBuilder<T: ArrowPrimitiveType> { /* private fields */ }
Expand description

Builder for PrimitiveArray

Implementations§

source§

impl<T: ArrowPrimitiveType> PrimitiveBuilder<T>

source

pub fn new() -> Self

Creates a new primitive array builder

source

pub fn with_capacity(capacity: usize) -> Self

Creates a new primitive array builder with capacity no of items

source

pub fn new_from_buffer( values_buffer: MutableBuffer, null_buffer: Option<MutableBuffer> ) -> Self

Creates a new primitive array builder from buffers

source

pub fn with_data_type(self, data_type: DataType) -> Self

By default PrimitiveBuilder uses ArrowPrimitiveType::DATA_TYPE as the data type of the generated array.

This method allows overriding the data type, to allow specifying timezones for DataType::Timestamp or precision and scale for DataType::Decimal128 and DataType::Decimal256

§Panics

This method panics if data_type is not PrimitiveArray::is_compatible

source

pub fn capacity(&self) -> usize

Returns the capacity of this builder measured in slots of type T

source

pub fn append_value(&mut self, v: T::Native)

Appends a value of type T into the builder

source

pub fn append_null(&mut self)

Appends a null slot into the builder

source

pub fn append_nulls(&mut self, n: usize)

Appends n no. of null’s into the builder

source

pub fn append_option(&mut self, v: Option<T::Native>)

Appends an Option<T> into the builder

source

pub fn append_slice(&mut self, v: &[T::Native])

Appends a slice of type T into the builder

source

pub fn append_values(&mut self, values: &[T::Native], is_valid: &[bool])

Appends values from a slice of type T and a validity boolean slice

§Panics

Panics if values and is_valid have different lengths

source

pub unsafe fn append_trusted_len_iter( &mut self, iter: impl IntoIterator<Item = T::Native> )

Appends values from a trusted length iterator.

§Safety

This requires the iterator be a trusted length. This could instead require the iterator implement TrustedLen once that is stabilized.

source

pub fn finish(&mut self) -> PrimitiveArray<T>

Builds the PrimitiveArray and reset this builder.

source

pub fn finish_cloned(&self) -> PrimitiveArray<T>

Builds the PrimitiveArray without resetting the builder.

source

pub fn values_slice(&self) -> &[T::Native]

Returns the current values buffer as a slice

source

pub fn values_slice_mut(&mut self) -> &mut [T::Native]

Returns the current values buffer as a mutable slice

source

pub fn validity_slice(&self) -> Option<&[u8]>

Returns the current null buffer as a slice

source

pub fn validity_slice_mut(&mut self) -> Option<&mut [u8]>

Returns the current null buffer as a mutable slice

source

pub fn slices_mut(&mut self) -> (&mut [T::Native], Option<&mut [u8]>)

Returns the current values buffer and null buffer as a slice

source§

impl<P: DecimalType> PrimitiveBuilder<P>

source

pub fn with_precision_and_scale( self, precision: u8, scale: i8 ) -> Result<Self, ArrowError>

Sets the precision and scale

source§

impl<P: ArrowTimestampType> PrimitiveBuilder<P>

source

pub fn with_timezone(self, timezone: impl Into<Arc<str>>) -> Self

Sets the timezone

source

pub fn with_timezone_opt<S: Into<Arc<str>>>(self, timezone: Option<S>) -> Self

Sets an optional timezone

Trait Implementations§

source§

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

source§

fn as_any(&self) -> &dyn Any

Returns the builder as a non-mutable Any reference.

source§

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

Returns the builder as a mutable Any reference.

source§

fn into_box_any(self: Box<Self>) -> Box<dyn Any>

Returns the boxed builder as a box of Any.

source§

fn len(&self) -> usize

Returns the number of array slots in the builder

source§

fn finish(&mut self) -> ArrayRef

Builds the array and reset this builder.

source§

fn finish_cloned(&self) -> ArrayRef

Builds the array without resetting the builder.

source§

fn is_empty(&self) -> bool

Returns whether number of array slots is zero
source§

impl<T: Debug + ArrowPrimitiveType> Debug for PrimitiveBuilder<T>
where T::Native: Debug,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<T: ArrowPrimitiveType> Default for PrimitiveBuilder<T>

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<P: ArrowPrimitiveType> Extend<Option<<P as ArrowPrimitiveType>::Native>> for PrimitiveBuilder<P>

source§

fn extend<T: IntoIterator<Item = Option<P::Native>>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,