Struct arrow::array::builder::GenericByteBuilder
source · pub struct GenericByteBuilder<T>where
T: ByteArrayType,{ /* private fields */ }
Expand description
Builder for GenericByteArray
Implementations§
source§impl<T> GenericByteBuilder<T>where
T: ByteArrayType,
impl<T> GenericByteBuilder<T>where
T: ByteArrayType,
sourcepub fn new() -> GenericByteBuilder<T>
pub fn new() -> GenericByteBuilder<T>
Creates a new GenericByteBuilder
.
sourcepub fn with_capacity(
item_capacity: usize,
data_capacity: usize,
) -> GenericByteBuilder<T>
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).
sourcepub unsafe fn new_from_buffer(
offsets_buffer: MutableBuffer,
value_buffer: MutableBuffer,
null_buffer: Option<MutableBuffer>,
) -> GenericByteBuilder<T>
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
.
sourcepub fn append_value(&mut self, value: impl AsRef<<T as ByteArrayType>::Native>)
pub fn append_value(&mut self, value: impl AsRef<<T as ByteArrayType>::Native>)
Appends a value into the builder.
§Panics
Panics if the resulting length of Self::values_slice
would exceed T::Offset::MAX
sourcepub fn append_option(
&mut self,
value: Option<impl AsRef<<T as ByteArrayType>::Native>>,
)
pub fn append_option( &mut self, value: Option<impl AsRef<<T as ByteArrayType>::Native>>, )
Append an Option
value into the builder.
sourcepub fn append_null(&mut self)
pub fn append_null(&mut self)
Append a null value into the builder.
sourcepub fn finish(&mut self) -> GenericByteArray<T>
pub fn finish(&mut self) -> GenericByteArray<T>
Builds the GenericByteArray
and reset this builder.
sourcepub fn finish_cloned(&self) -> GenericByteArray<T>
pub fn finish_cloned(&self) -> GenericByteArray<T>
Builds the GenericByteArray
without resetting the builder.
sourcepub fn values_slice(&self) -> &[u8] ⓘ
pub fn values_slice(&self) -> &[u8] ⓘ
Returns the current values buffer as a slice
sourcepub fn offsets_slice(&self) -> &[<T as ByteArrayType>::Offset]
pub fn offsets_slice(&self) -> &[<T as ByteArrayType>::Offset]
Returns the current offsets buffer as a slice
sourcepub fn validity_slice(&self) -> Option<&[u8]>
pub fn validity_slice(&self) -> Option<&[u8]>
Returns the current null buffer as a slice
sourcepub fn validity_slice_mut(&mut self) -> Option<&mut [u8]>
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,
impl<T> ArrayBuilder for GenericByteBuilder<T>where
T: ByteArrayType,
source§fn finish_cloned(&self) -> Arc<dyn Array>
fn finish_cloned(&self) -> Arc<dyn Array>
Builds the array without resetting the builder.
source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
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>
fn into_box_any(self: Box<GenericByteBuilder<T>>) -> Box<dyn Any>
Returns the boxed builder as a box of Any
.
source§impl<T> Debug for GenericByteBuilder<T>where
T: ByteArrayType,
impl<T> Debug for GenericByteBuilder<T>where
T: ByteArrayType,
source§impl<T> Default for GenericByteBuilder<T>where
T: ByteArrayType,
impl<T> Default for GenericByteBuilder<T>where
T: ByteArrayType,
source§fn default() -> GenericByteBuilder<T>
fn default() -> GenericByteBuilder<T>
source§impl<T, V> Extend<Option<V>> for GenericByteBuilder<T>
impl<T, V> Extend<Option<V>> for GenericByteBuilder<T>
source§fn extend<I>(&mut self, iter: I)where
I: IntoIterator<Item = Option<V>>,
fn extend<I>(&mut self, iter: I)where
I: IntoIterator<Item = Option<V>>,
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)