Struct arrow_array::builder::FixedSizeBinaryBuilder

pub struct FixedSizeBinaryBuilder { /* private fields */ }

A fixed size binary array builder

use arrow_array::builder::FixedSizeBinaryBuilder;
use arrow_array::Array;

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");

Implementations

impl FixedSizeBinaryBuilder

pub fn new(byte_width: i32) -> Self

Creates a new FixedSizeBinaryBuilder

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

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.

pub fn append_null(&mut self)

Append a null value to the array.

pub fn finish(&mut self) -> FixedSizeBinaryArray

Builds the FixedSizeBinaryArray and reset this builder.

pub fn finish_cloned(&self) -> FixedSizeBinaryArray

Builds the FixedSizeBinaryArray without resetting the builder.

Trait Implementations

impl ArrayBuilder for FixedSizeBinaryBuilder

fn as_any(&self) -> &dyn Any

Returns the builder as a non-mutable Any reference.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the builder as a mutable Any reference.

fn into_box_any(self: Box<Self>) -> Box<dyn Any>

Returns the boxed builder as a box of Any.

fn len(&self) -> usize

Returns the number of array slots in the builder

fn is_empty(&self) -> bool

Returns whether the number of array slots is zero

fn finish(&mut self) -> ArrayRef

Builds the array and reset this builder.

fn finish_cloned(&self) -> ArrayRef

Builds the array without resetting the builder.

impl Debug for FixedSizeBinaryBuilder

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

Formats the value using the given formatter.