Struct arrow_array::builder::BooleanBuilder

pub struct BooleanBuilder { /* private fields */ }

Builder for BooleanArray

Example

Create a BooleanArray from a BooleanBuilder

let mut b = BooleanBuilder::new();
b.append_value(true);
b.append_null();
b.append_value(false);
b.append_value(true);
let arr = b.finish();

assert_eq!(4, arr.len());
assert_eq!(1, arr.null_count());
assert_eq!(true, arr.value(0));
assert!(arr.is_valid(0));
assert!(!arr.is_null(0));
assert!(!arr.is_valid(1));
assert!(arr.is_null(1));
assert_eq!(false, arr.value(2));
assert!(arr.is_valid(2));
assert!(!arr.is_null(2));
assert_eq!(true, arr.value(3));
assert!(arr.is_valid(3));
assert!(!arr.is_null(3));

Implementations

impl BooleanBuilder

pub fn new() -> Self

Creates a new boolean builder

pub fn with_capacity(capacity: usize) -> Self

Creates a new boolean builder with space for capacity elements without re-allocating

pub fn capacity(&self) -> usize

Returns the capacity of this builder measured in slots of type T

pub fn append_value(&mut self, v: bool)

Appends a value of type T into the builder

pub fn append_null(&mut self)

Appends a null slot into the builder

pub fn append_nulls(&mut self, n: usize)

Appends n nulls into the builder.

pub fn append_option(&mut self, v: Option<bool>)

Appends an Option<T> into the builder

pub fn append_slice(&mut self, v: &[bool])

Appends a slice of type T into the builder

pub fn append_n(&mut self, additional: usize, v: bool)

Appends n additional bits of value v into the buffer

pub fn append_values( &mut self, values: &[bool], is_valid: &[bool], ) -> Result<(), ArrowError>

Appends values from a slice of type T and a validity boolean slice.

Returns an error if the slices are of different lengths

pub fn finish(&mut self) -> BooleanArray

Builds the BooleanArray and reset this builder.

pub fn finish_cloned(&self) -> BooleanArray

Builds the BooleanArray without resetting the builder.

pub fn values_slice(&self) -> &[u8]

Returns the current values buffer as a slice

Boolean values are bit-packed into bytes. To extract the i-th boolean from the bytes, you can use arrow_buffer::bit_util::get_bit().

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

Returns the current null buffer as a slice

Trait Implementations

impl ArrayBuilder for BooleanBuilder

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 finish(&mut self) -> ArrayRef

Builds the array and reset this builder.

fn finish_cloned(&self) -> ArrayRef

Builds the array without resetting the builder.

fn is_empty(&self) -> bool

Returns whether number of array slots is zero

impl Debug for BooleanBuilder

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

Formats the value using the given formatter.

impl Default for BooleanBuilder

fn default() -> Self

Returns the “default value” for a type.

impl Extend<Option<bool>> for BooleanBuilder

fn extend<T: IntoIterator<Item = Option<bool>>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

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.