Struct arrow2::array::BooleanArray

pub struct BooleanArray { /* fields omitted */ }

A BooleanArray is arrow’s equivalent to Vec<Option<bool>>, i.e. an array designed for highly performant operations on optionally nullable booleans. The size of this struct is O(1) as all data is stored behind an Arc.

Implementations

impl BooleanArray

pub fn from_trusted_len_values_iter<I: TrustedLen<Item = bool>>(
    iterator: I
) -> Self

Creates a new BooleanArray from an TrustedLen of bool.

pub fn from_slice<P: AsRef<[bool]>>(slice: P) -> Self

Creates a new BooleanArray from a slice of bool.

pub unsafe fn from_trusted_len_iter_unchecked<I, P>(iterator: I) -> Self where
    P: Borrow<bool>,
    I: Iterator<Item = Option<P>>, 

Creates a BooleanArray from an iterator of trusted length. Use this over BooleanArray::from_trusted_len_iter when the iterator is trusted len but this crate does not mark it as such.

Safety

The iterator must be TrustedLen. I.e. that size_hint().1 correctly reports its length.

pub fn from_trusted_len_iter<I, P>(iterator: I) -> Self where
    P: Borrow<bool>,
    I: TrustedLen<Item = Option<P>>, 

Creates a BooleanArray from a TrustedLen.

pub unsafe fn try_from_trusted_len_iter_unchecked<E, I, P>(
    iterator: I
) -> Result<Self, E> where
    P: Borrow<bool>,
    I: Iterator<Item = Result<Option<P>, E>>, 

Creates a BooleanArray from an falible iterator of trusted length.

Safety

The iterator must be TrustedLen. I.e. that size_hint().1 correctly reports its length.

pub fn try_from_trusted_len_iter<E, I, P>(iterator: I) -> Result<Self, E> where
    P: Borrow<bool>,
    I: TrustedLen<Item = Result<Option<P>, E>>, 

Creates a BooleanArray from a TrustedLen.

impl<'a> BooleanArray

pub fn iter(&'a self) -> ZipValidity<'a, bool, BitmapIter<'a>>

constructs a new iterator

pub fn values_iter(&'a self) -> BitmapIter<'a>

Returns an iterator of bool

impl BooleanArray

pub fn new_empty() -> Self

Returns a new empty BooleanArray.

pub fn new_null(length: usize) -> Self

Returns a new BooleanArray whose all slots are null / None.

pub fn from_data(values: Bitmap, validity: Option<Bitmap>) -> Self

The canonical method to create a BooleanArray out of low-end APIs.

Panics

This function panics iff:

• The validity is not None and its length is different from values’s length

pub fn slice(&self, offset: usize, length: usize) -> Self

Returns a slice of this BooleanArray.

Implementation

This operation is O(1) as it amounts to essentially increase two ref counts.

Panic

This function panics iff offset + length >= self.len().

pub fn value(&self, i: usize) -> bool

Returns the element at index i as bool

pub unsafe fn value_unchecked(&self, i: usize) -> bool

Returns the element at index i as bool

Safety

Caller must be sure that i < self.len()

pub fn values(&self) -> &Bitmap

Returns the values bitmap of this BooleanArray.

Trait Implementations

impl Array for BooleanArray

fn as_any(&self) -> &dyn Any

fn len(&self) -> usize

The length of the Array. Every array has a length corresponding to the number of elements (slots).

fn data_type(&self) -> &DataType

The DataType of the Array. In combination with Array::as_any, this can be used to downcast trait objects (dyn Array) to concrete arrays.

fn validity(&self) -> &Option<Bitmap>

The validity of the Array: every array has an optional Bitmap that, when available specifies whether the array slot is valid or not (null). When the validity is None, all slots are valid.

fn slice(&self, offset: usize, length: usize) -> Box<dyn Array>

Slices the Array, returning a new Box<dyn Array>.

fn is_empty(&self) -> bool

whether the array is empty

fn null_count(&self) -> usize

The number of null slots on this Array. This is usually used to branch implementations to cases where optimizations can be made.

fn is_null(&self, i: usize) -> bool

Returns whether slot i is null.

fn is_valid(&self, i: usize) -> bool

Returns whether slot i is valid.

impl Clone for BooleanArray

fn clone(&self) -> BooleanArray

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BooleanArray

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

Formats the value using the given formatter.

impl Display for BooleanArray

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

Formats the value using the given formatter.

impl<'a> From<GrowableBoolean<'a>> for BooleanArray

fn from(val: GrowableBoolean<'a>) -> Self

Performs the conversion.

impl From<MutableBooleanArray> for BooleanArray

fn from(other: MutableBooleanArray) -> Self

Performs the conversion.

impl<P: AsRef<[Option<bool>]>> From<P> for BooleanArray

fn from(slice: P) -> Self

Creates a new BooleanArray out of a slice of Optional bool.

impl<A: ArrowArrayRef> FromFfi<A> for BooleanArray

fn try_from_ffi(array: A) -> Result<Self>

impl<Ptr: Borrow<Option<bool>>> FromIterator<Ptr> for BooleanArray

fn from_iter<I: IntoIterator<Item = Ptr>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a BooleanArray

type Item = Option<bool>

The type of the elements being iterated over.

type IntoIter = ZipValidity<'a, bool, BitmapIter<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<&'_ (dyn Array + '_)> for BooleanArray

fn eq(&self, other: &&dyn Array) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<BooleanArray> for BooleanArray

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl ToFfi for BooleanArray

fn buffers(&self) -> Vec<Option<NonNull<u8>>>

The pointers to the buffers.

fn offset(&self) -> usize

The offset

fn children(&self) -> Vec<Arc<dyn Array>>

The children