arrow_array::builder::boolean_builder

Struct BooleanBuilder

Source
pub struct BooleanBuilder {
    values_builder: BooleanBufferBuilder,
    null_buffer_builder: NullBufferBuilder,
}
Expand description

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

Fields§

§values_builder: BooleanBufferBuilder§null_buffer_builder: NullBufferBuilder

Implementations§

Source§

impl BooleanBuilder

Source

pub fn new() -> Self

Creates a new boolean builder

Source

pub fn with_capacity(capacity: usize) -> Self

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

Source

pub fn capacity(&self) -> usize

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

Source

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

Appends a value of type T into the builder

Source

pub fn append_null(&mut self)

Appends a null slot into the builder

Source

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

Appends n nulls into the builder.

Source

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

Appends an Option<T> into the builder

Source

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

Appends a slice of type T into the builder

Source

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

Appends n additional bits of value v into the buffer

Source

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

Source

pub fn finish(&mut self) -> BooleanArray

Builds the BooleanArray and reset this builder.

Source

pub fn finish_cloned(&self) -> BooleanArray

Builds the BooleanArray without resetting the builder.

Source

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().

Source

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

Returns the current null buffer as a slice

Trait Implementations§

Source§

impl ArrayBuilder for BooleanBuilder

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 BooleanBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BooleanBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Extend<Option<bool>> for BooleanBuilder

Source§

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

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

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