Struct arrow_array::builder::GenericByteBuilder

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

Builder for GenericByteArray

Implementations§

source§

impl<T: ByteArrayType> GenericByteBuilder<T>

source

pub fn new() -> Self

Creates a new GenericByteBuilder.

source

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).
source

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.

source

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

source

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

Append an Option value into the builder.

source

pub fn append_null(&mut self)

Append a null value into the builder.

source

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

Builds the GenericByteArray and reset this builder.

source

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

Builds the GenericByteArray without resetting the builder.

source

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

Returns the current values buffer as a slice

source

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

Returns the current offsets buffer as a 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

Trait Implementations§

source§

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

source§

fn len(&self) -> usize

Returns the number of binary 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 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 is_empty(&self) -> bool

Returns whether number of array slots is zero
source§

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

source§

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

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

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

source§

fn default() -> Self

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

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

source§

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

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,