arrow_array::builder

Struct FixedSizeBinaryBuilder

Source
pub struct FixedSizeBinaryBuilder {
    values_builder: UInt8BufferBuilder,
    null_buffer_builder: NullBufferBuilder,
    value_length: i32,
}
Expand description

Builder for FixedSizeBinaryArray

let mut builder = FixedSizeBinaryBuilder::with_capacity(3, 5);
// [b"hello", null, b"arrow"]
builder.append_value(b"hello").unwrap();
builder.append_null();
builder.append_value(b"arrow").unwrap();

let array = builder.finish();
assert_eq!(array.value(0), b"hello");
assert!(array.is_null(1));
assert_eq!(array.value(2), b"arrow");

Fields§

§values_builder: UInt8BufferBuilder§null_buffer_builder: NullBufferBuilder§value_length: i32

Implementations§

Source§

impl FixedSizeBinaryBuilder

Source

pub fn new(byte_width: i32) -> Self

Creates a new FixedSizeBinaryBuilder

Source

pub fn with_capacity(capacity: usize, byte_width: i32) -> Self

Creates a new FixedSizeBinaryBuilder, capacity is the number of byte slices that can be appended without reallocating

Source

pub fn append_value( &mut self, value: impl AsRef<[u8]>, ) -> Result<(), ArrowError>

Appends a byte slice into the builder.

Automatically update the null buffer to delimit the slice appended in as a distinct value element.

Source

pub fn append_null(&mut self)

Append a null value to the array.

Source

pub fn finish(&mut self) -> FixedSizeBinaryArray

Builds the FixedSizeBinaryArray and reset this builder.

Source

pub fn finish_cloned(&self) -> FixedSizeBinaryArray

Builds the FixedSizeBinaryArray without resetting the builder.

Source

pub fn validity_slice(&self) -> Option<&[u8]>

Returns the current null buffer as a slice

Trait Implementations§

Source§

impl ArrayBuilder for FixedSizeBinaryBuilder

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 len(&self) -> usize

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

Returns whether number of array slots is zero
Source§

impl Debug for FixedSizeBinaryBuilder

Source§

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

Formats the value using the given formatter. 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>,

Source§

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>,

Source§

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

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,