Struct arrow::array::GenericByteBuilder

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

Builder for GenericByteArray

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

Implementations

impl<T> GenericByteBuilder<T>

where T: ByteArrayType,

pub fn new() -> GenericByteBuilder<T>

Creates a new GenericByteBuilder.

pub fn with_capacity( item_capacity: usize, data_capacity: usize, ) -> GenericByteBuilder<T>

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>, ) -> GenericByteBuilder<T>

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 as ByteArrayType>::Native>)

Appends a value into the builder.

See the GenericStringBuilder documentation for examples of incrementally building string values with multiple write! calls.

Panics

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

For example, this can happen with StringArray or BinaryArray where the total length of all values exceeds 2GB

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

Append an Option value into the builder.

• A None value will append a null value.
• A Some value will append the value.

See Self::append_value for more panic information.

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 as ByteArrayType>::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> ArrayBuilder for GenericByteBuilder<T>

where T: ByteArrayType,

fn len(&self) -> usize

Returns the number of binary slots in the builder

fn finish(&mut self) -> Arc<dyn Array>

Builds the array and reset this builder.

fn finish_cloned(&self) -> Arc<dyn Array>

Builds the array without resetting the builder.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the builder as a non-mutable Any reference.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the builder as a mutable Any reference.

fn into_box_any(self: Box<GenericByteBuilder<T>>) -> 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> Debug for GenericByteBuilder<T>

where T: ByteArrayType,

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

Formats the value using the given formatter.

impl<T> Default for GenericByteBuilder<T>

where T: ByteArrayType,

fn default() -> GenericByteBuilder<T>

Returns the “default value” for a type.

impl<T, V> Extend<Option<V>> for GenericByteBuilder<T>

where T: ByteArrayType, V: AsRef<<T as ByteArrayType>::Native>,

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = Option<V>>,

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.

impl<O> Write for GenericByteBuilder<GenericBinaryType<O>>

where O: OffsetSizeTrait,

fn write(&mut self, bs: &[u8]) -> Result<usize, Error>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<(), Error>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl<O> Write for GenericByteBuilder<GenericStringType<O>>

where O: OffsetSizeTrait,

fn write_str(&mut self, s: &str) -> Result<(), Error>

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.