Struct arrow::array::BooleanArray

pub struct BooleanArray { /* private fields */ }

Array of bools

Example

    use arrow_array::{Array, BooleanArray};
    let arr = BooleanArray::from(vec![Some(false), Some(true), None, Some(true)]);
    assert_eq!(4, arr.len());
    assert_eq!(1, arr.null_count());
    assert!(arr.is_valid(0));
    assert!(!arr.is_null(0));
    assert_eq!(false, arr.value(0));
    assert!(arr.is_valid(1));
    assert!(!arr.is_null(1));
    assert_eq!(true, arr.value(1));
    assert!(!arr.is_valid(2));
    assert!(arr.is_null(2));
    assert!(arr.is_valid(3));
    assert!(!arr.is_null(3));
    assert_eq!(true, arr.value(3));

Using from_iter

    use arrow_array::{Array, BooleanArray};
    let v = vec![Some(false), Some(true), Some(false), Some(true)];
    let arr = v.into_iter().collect::<BooleanArray>();
    assert_eq!(4, arr.len());
    assert_eq!(0, arr.offset());
    assert_eq!(0, arr.null_count());
    assert!(arr.is_valid(0));
    assert_eq!(false, arr.value(0));
    assert!(arr.is_valid(1));
    assert_eq!(true, arr.value(1));
    assert!(arr.is_valid(2));
    assert_eq!(false, arr.value(2));
    assert!(arr.is_valid(3));
    assert_eq!(true, arr.value(3));

Implementations

impl BooleanArray

pub fn new(values: BooleanBuffer, nulls: Option<NullBuffer>) -> BooleanArray

Create a new BooleanArray from the provided values and nulls

Panics

Panics if values.len() != nulls.len()

pub fn len(&self) -> usize

Returns the length of this array.

pub fn is_empty(&self) -> bool

Returns whether this array is empty.

pub fn builder(capacity: usize) -> BooleanBuilder

Returns a new boolean array builder

pub fn values(&self) -> &BooleanBuffer

Returns the underlying BooleanBuffer holding all the values of this array

pub fn true_count(&self) -> usize

Returns the number of non null, true values within this array

pub fn false_count(&self) -> usize

Returns the number of non null, false values within this array

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

Returns the boolean value at index i.

Safety

This doesn’t check bounds, the caller must ensure that index < self.len()

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

Returns the boolean value at index i.

Panics

Panics if index i is out of bounds

pub fn take_iter<'a>( &'a self, indexes: impl Iterator<Item = Option<usize>> + 'a ) -> impl Iterator<Item = Option<bool>> + 'a

Returns an iterator that returns the values of array.value(i) for an iterator with each element i

pub unsafe fn take_iter_unchecked<'a>( &'a self, indexes: impl Iterator<Item = Option<usize>> + 'a ) -> impl Iterator<Item = Option<bool>> + 'a

Returns an iterator that returns the values of array.value(i) for an iterator with each element i

Safety

caller must ensure that the offsets in the iterator are less than the array len()

pub fn from_unary<T, F>(left: T, op: F) -> BooleanArraywhere T: ArrayAccessor, F: FnMut(<T as ArrayAccessor>::Item) -> bool,

Create a BooleanArray by evaluating the operation for each element of the provided array

let array = Int32Array::from(vec![1, 2, 3, 4, 5]);
let r = BooleanArray::from_unary(&array, |x| x > 2);
assert_eq!(&r, &BooleanArray::from(vec![false, false, true, true, true]));

pub fn from_binary<T, S, F>(left: T, right: S, op: F) -> BooleanArraywhere T: ArrayAccessor, S: ArrayAccessor, F: FnMut(<T as ArrayAccessor>::Item, <S as ArrayAccessor>::Item) -> bool,

Create a BooleanArray by evaluating the binary operation for each element of the provided arrays

let a = Int32Array::from(vec![1, 2, 3, 4, 5]);
let b = Int32Array::from(vec![1, 2, 0, 2, 5]);
let r = BooleanArray::from_binary(&a, &b, |a, b| a == b);
assert_eq!(&r, &BooleanArray::from(vec![true, true, false, false, true]));

Panics

This function panics if left and right are not the same length

impl<'a> BooleanArray

pub fn iter(&'a self) -> ArrayIter<&'a BooleanArray>

constructs a new iterator

Trait Implementations

impl Array for BooleanArray

fn as_any(&self) -> &(dyn Any + 'static)

Returns the array as Any so that it can be downcasted to a specific implementation.

fn data(&self) -> &ArrayData

Returns a reference to the underlying data of this array

fn to_data(&self) -> ArrayData

Returns the underlying data of this array

fn into_data(self) -> ArrayData

Returns the underlying data of this array

fn slice(&self, offset: usize, length: usize) -> Arc<dyn Array + 'static>

Returns a zero-copy slice of this array with the indicated offset and length.

fn nulls(&self) -> Option<&NullBuffer>

Returns the null buffers of this array if any

fn data_ref(&self) -> &ArrayData

Returns a reference-counted pointer to the underlying data of this array.

fn data_type(&self) -> &DataType

Returns a reference to the DataType of this array.

fn len(&self) -> usize

Returns the length (i.e., number of elements) of this array.

fn is_empty(&self) -> bool

Returns whether this array is empty.

fn offset(&self) -> usize

Returns the offset into the underlying data used by this array(-slice). Note that the underlying data can be shared by many arrays. This defaults to 0.

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

Returns whether the element at index is null. When using this function on a slice, the index is relative to the slice.

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

Returns whether the element at index is not null. When using this function on a slice, the index is relative to the slice.

fn null_count(&self) -> usize

Returns the total number of null values in this array.

fn get_buffer_memory_size(&self) -> usize

Returns the total number of bytes of memory pointed to by this array. The buffers store bytes in the Arrow memory format, and include the data as well as the validity map.

fn get_array_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied physically by this array. This value will always be greater than returned by get_buffer_memory_size() and includes the overhead of the data structures that contain the pointers to the various buffers.

impl<'a> ArrayAccessor for &'a BooleanArray

type Item = bool

The Arrow type of the element being accessed.

fn value(&self, index: usize) -> <&'a BooleanArray as ArrayAccessor>::Item

Returns the element at index i

unsafe fn value_unchecked( &self, index: usize ) -> <&'a BooleanArray as ArrayAccessor>::Item

Returns the element at index i

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<(), Error>

Formats the value using the given formatter.

impl From<ArrayData> for BooleanArray

fn from(data: ArrayData) -> BooleanArray

Converts to this type from the input type.

impl From<BooleanArray> for ArrayData

fn from(array: BooleanArray) -> ArrayData

Converts to this type from the input type.

impl From<Vec<Option<bool>, Global>> for BooleanArray

fn from(data: Vec<Option<bool>, Global>) -> BooleanArray

Converts to this type from the input type.

impl From<Vec<bool, Global>> for BooleanArray

fn from(data: Vec<bool, Global>) -> BooleanArray

Converts to this type from the input type.

impl<Ptr> FromIterator<Ptr> for BooleanArraywhere Ptr: Borrow<Option<bool>>,

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

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 = ArrayIter<&'a BooleanArray>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a BooleanArray as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq<BooleanArray> for BooleanArray

fn eq(&self, other: &BooleanArray) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.