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>
impl<T: ByteArrayType> GenericByteBuilder<T>
sourcepub fn new() -> Self
pub fn new() -> Self
Creates a new GenericByteBuilder
.
sourcepub fn with_capacity(item_capacity: usize, data_capacity: usize) -> Self
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).
sourcepub unsafe fn new_from_buffer(
offsets_buffer: MutableBuffer,
value_buffer: MutableBuffer,
null_buffer: Option<MutableBuffer>,
) -> Self
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
.
sourcepub fn append_value(&mut self, value: impl AsRef<T::Native>)
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
sourcepub fn append_option(&mut self, value: Option<impl AsRef<T::Native>>)
pub fn append_option(&mut self, value: Option<impl AsRef<T::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::Offset]
pub fn offsets_slice(&self) -> &[T::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: ByteArrayType> ArrayBuilder for GenericByteBuilder<T>
impl<T: ByteArrayType> ArrayBuilder for GenericByteBuilder<T>
source§fn finish_cloned(&self) -> ArrayRef
fn finish_cloned(&self) -> ArrayRef
Builds the array without resetting the builder.
source§fn as_any_mut(&mut self) -> &mut dyn Any
fn as_any_mut(&mut self) -> &mut dyn Any
Returns the builder as a mutable Any
reference.
source§impl<T: ByteArrayType> Debug for GenericByteBuilder<T>
impl<T: ByteArrayType> Debug for GenericByteBuilder<T>
source§impl<T: ByteArrayType> Default for GenericByteBuilder<T>
impl<T: ByteArrayType> Default for GenericByteBuilder<T>
source§impl<T: ByteArrayType, V: AsRef<T::Native>> Extend<Option<V>> for GenericByteBuilder<T>
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)
fn extend<I: IntoIterator<Item = Option<V>>>(&mut self, iter: I)
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
)