arrow::array::builder

Type Alias StringBuilder

Source
pub type StringBuilder = GenericByteBuilder<GenericStringType<i32>>;
Expand description

Builder for StringArray

See examples on GenericStringBuilder

Aliased Type§

struct StringBuilder { /* private fields */ }

Implementations

Source§

impl<T> GenericByteBuilder<T>
where T: ByteArrayType,

Source

pub fn new() -> GenericByteBuilder<T>

Creates a new GenericByteBuilder.

Source

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

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.

Source

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

Source

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.

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

Source§

fn len(&self) -> usize

Returns the number of binary slots in the builder

Source§

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

Builds the array and reset this builder.

Source§

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

Builds the array without resetting the builder.

Source§

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

Returns the builder as a non-mutable Any reference.

Source§

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

Returns the builder as a mutable Any reference.

Source§

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

Source§

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

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

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

Source§

fn default() -> GenericByteBuilder<T>

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

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

Source§

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

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
Source§

impl<O> Write for GenericByteBuilder<GenericStringType<O>>
where O: OffsetSizeTrait,

Source§

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

Writes a string slice into this writer, returning whether the write succeeded. Read more
1.1.0 · Source§

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

Writes a char into this writer, returning whether the write succeeded. Read more
1.0.0 · Source§

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

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