Struct arrow_array::builder::GenericByteBuilder

pub struct GenericByteBuilder<T: ByteArrayType> { /* private fields */ }

Builder for GenericByteArray

For building strings, see docs on GenericStringBuilder. For building binary, see docs on GenericBinaryBuilder.

Implementations

impl<T: ByteArrayType> GenericByteBuilder<T>

pub fn new() -> Self

Creates a new GenericByteBuilder.

pub fn with_capacity(item_capacity: usize, data_capacity: usize) -> Self

Creates a new GenericByteBuilder.

• item_capacity is the number of items to pre-allocate. The size of the preallocated buffer of offsets is the number of items plus one.
• data_capacity is the total number of bytes of data to pre-allocate (for all items, not per item).

pub unsafe fn new_from_buffer( offsets_buffer: MutableBuffer, value_buffer: MutableBuffer, null_buffer: Option<MutableBuffer>, ) -> Self

Creates a new GenericByteBuilder from buffers.

Safety

This doesn’t verify buffer contents as it assumes the buffers are from existing and valid GenericByteArray.

pub fn append_value(&mut self, value: impl AsRef<T::Native>)

Appends a value into the builder.

Panics

Panics if the resulting length of Self::values_slice would exceed T::Offset::MAX

pub fn append_option(&mut self, value: Option<impl AsRef<T::Native>>)

Append an Option value into the builder.

pub fn append_null(&mut self)

Append a null value into the builder.

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

Builds the GenericByteArray and reset this builder.

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

Builds the GenericByteArray without resetting the builder.

pub fn values_slice(&self) -> &[u8]

Returns the current values buffer as a slice

pub fn offsets_slice(&self) -> &[T::Offset]

Returns the current offsets buffer as a slice

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

Returns the current null buffer as a slice

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

Returns the current null buffer as a mutable slice

Trait Implementations

impl<T: ByteArrayType> ArrayBuilder for GenericByteBuilder<T>

fn len(&self) -> usize

Returns the number of binary slots in the builder

fn finish(&mut self) -> ArrayRef

Builds the array and reset this builder.

fn finish_cloned(&self) -> ArrayRef

Builds the array without resetting the builder.

fn as_any(&self) -> &dyn Any

Returns the builder as a non-mutable Any reference.

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

Returns the builder as a mutable Any reference.

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

Returns the boxed builder as a box of Any.

fn is_empty(&self) -> bool

Returns whether number of array slots is zero

impl<T: ByteArrayType> Debug for GenericByteBuilder<T>

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

Formats the value using the given formatter.

impl<T: ByteArrayType> Default for GenericByteBuilder<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ByteArrayType, V: AsRef<T::Native>> Extend<Option<V>> for GenericByteBuilder<T>

fn extend<I: IntoIterator<Item = Option<V>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

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.