Struct BooleanArray 

pub struct BooleanArray {
    values: BooleanBuffer,
    nulls: Option<NullBuffer>,
}

An array of boolean values

Example: From a Vec

let arr: BooleanArray = vec![true, true, false].into();

Example: From an optional Vec

let arr: BooleanArray = vec![Some(true), None, Some(false)].into();

Example: From an iterator

let arr: BooleanArray = (0..5).map(|x| (x % 2 == 0).then(|| x % 3 == 0)).collect();
let values: Vec<_> = arr.iter().collect();
assert_eq!(&values, &[Some(true), None, Some(false), None, Some(false)])

Example: Using Builder

let mut builder = BooleanBuilder::new();
builder.append_value(true);
builder.append_null();
builder.append_value(false);
let array = builder.finish();
let values: Vec<_> = array.iter().collect();
assert_eq!(&values, &[Some(true), None, Some(false)])

Fields

values: BooleanBuffer

nulls: Option<NullBuffer>

Implementations

impl BooleanArray

const CHUNK_FOLD_BLOCK_SIZE: usize = 16

Block size for chunked fold operations in Self::has_true and Self::has_false. Using chunks_exact with this size lets the compiler fully unroll the inner fold (no inner branch/loop), enabling short-circuit exits every N chunks.

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

Create a new BooleanArray from the provided values and nulls

Panics

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

pub fn new_null(len: usize) -> Self

Create a new BooleanArray with length len consisting only of nulls

pub fn new_scalar(value: bool) -> Scalar<Self>

Create a new Scalar from value

pub fn new_from_packed( buffer: impl Into<Buffer>, offset: usize, len: usize, ) -> Self

Create a new BooleanArray from a [Buffer] specified by offset and len, the offset and len in bits Logically convert each bit in [Buffer] to boolean and use it to build BooleanArray. using this method will make the following points self-evident:

• there is no null in the constructed BooleanArray;
• without considering buffer.into(), this method is efficient because there is no need to perform pack and unpack operations on boolean;

pub fn new_from_u8(value: &[u8]) -> Self

Create a new BooleanArray from &[u8] This method uses new_from_packed and constructs a [Buffer] using value, and offset is set to 0 and len is set to value.len() * 8 using this method will make the following points self-evident:

• there is no null in the constructed BooleanArray;
• the length of the constructed BooleanArray is always a multiple of 8;

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 slice(&self, offset: usize, length: usize) -> Self

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

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

fn unaligned_bit_chunks(&self) -> UnalignedBitChunk<'_>

Returns an [UnalignedBitChunk] over this array’s values.

pub fn true_count(&self) -> usize

Returns the number of non null, true values within this array. If you only need to check if there is at least one true value, consider using has_true() which can short-circuit and be more efficient.

pub fn false_count(&self) -> usize

Returns the number of non null, false values within this array. If you only need to check if there is at least one false value, consider using has_false() which can short-circuit and be more efficient.

pub fn has_true(&self) -> bool

Returns whether there is at least one non-null true value in this array.

This is more efficient than true_count() > 0 because it can short-circuit as soon as a true value is found, without counting all set bits.

Null values are not counted as true. Returns false for empty arrays.

pub fn has_false(&self) -> bool

Returns whether there is at least one non-null false value in this array.

This is more efficient than false_count() > 0 because it can short-circuit as soon as a false value is found, without counting all set bits.

Null values are not counted as false. Returns false for empty arrays.

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

Returns the boolean value at index i.

Note: This method does not check for nulls and the value is arbitrary if is_null returns true for the index.

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.

Note: This method does not check for nulls and the value is arbitrary if is_null returns true for the index.

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: ArrayAccessor, F>(left: T, op: F) -> Self

where F: FnMut(T::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: ArrayAccessor, S: ArrayAccessor, F>( left: T, right: S, op: F, ) -> Self

where F: FnMut(T::Item, S::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

pub fn bitwise_unary<F>(&self, op: F) -> BooleanArray

where F: FnMut(u64) -> u64,

Apply a bitwise operation to this array’s values using u64 operations, returning a new BooleanArray.

The null buffer is preserved unchanged.

See [BooleanBuffer::from_bitwise_unary_op] for details on the operation.

Example

let array = BooleanArray::from(vec![true, false, true]);
let result = array.bitwise_unary(|x| !x);
assert_eq!(result, BooleanArray::from(vec![false, true, false]));

pub fn bitwise_unary_mut<F>(self, op: F) -> Result<BooleanArray, BooleanArray>

where F: FnMut(u64) -> u64,

Try to apply a bitwise operation to this array’s values in place using u64 operations.

If the underlying buffer is uniquely owned, the operation is applied in place and Ok is returned. If the buffer is shared, Err(self) is returned so the caller can fall back to bitwise_unary.

The null buffer is preserved unchanged.

Example

let array = BooleanArray::from(vec![true, false, true]);
let result = array.bitwise_unary_mut(|x| !x).unwrap();
assert_eq!(result, BooleanArray::from(vec![false, true, false]));

pub fn bitwise_unary_mut_or_clone<F>(self, op: F) -> BooleanArray

where F: FnMut(u64) -> u64,

Apply a bitwise operation to this array’s values in place if the buffer is uniquely owned, or clone and apply if shared.

This is a convenience wrapper around bitwise_unary_mut that falls back to bitwise_unary when the buffer is shared.

The null buffer is preserved unchanged.

Example

let array = BooleanArray::from(vec![true, false, true]);
let result = array.bitwise_unary_mut_or_clone(|x| !x);
assert_eq!(result, BooleanArray::from(vec![false, true, false]));

fn try_bitwise_unary_in_place<F>( self, op: F, ) -> Result<BooleanArray, (BooleanArray, F)>

where F: FnMut(u64) -> u64,

Try to apply a unary op in place. Returns op back on failure so callers can fall back to an allocating path without requiring F: Clone.

pub fn bitwise_bin_op<F>(&self, rhs: &BooleanArray, op: F) -> BooleanArray

where F: FnMut(u64, u64) -> u64,

Apply a bitwise binary operation to this array and rhs using u64 operations, returning a new BooleanArray.

Null buffers are unioned: the result is null where either input is null.

See [BooleanBuffer::from_bitwise_binary_op] for details on the operation.

Panics

Panics if self and rhs have different lengths.

Example

let a = BooleanArray::from(vec![true, false, true, true]);
let b = BooleanArray::from(vec![true, true, false, true]);
let result = a.bitwise_bin_op(&b, |a, b| a & b);
assert_eq!(result, BooleanArray::from(vec![true, false, false, true]));

pub fn bitwise_bin_op_mut<F>( self, rhs: &BooleanArray, op: F, ) -> Result<BooleanArray, BooleanArray>

where F: FnMut(u64, u64) -> u64,

Try to apply a bitwise binary operation to this array and rhs in place using u64 operations.

If this array’s underlying buffer is uniquely owned, the operation is applied in place and Ok is returned. If the buffer is shared, Err(self) is returned so the caller can fall back to bitwise_bin_op.

Null buffers are unioned: the result is null where either input is null.

Panics

Panics if self and rhs have different lengths.

Example

let a = BooleanArray::from(vec![true, false, true, true]);
let b = BooleanArray::from(vec![true, true, false, true]);
let result = a.bitwise_bin_op_mut(&b, |a, b| a & b).unwrap();
assert_eq!(result, BooleanArray::from(vec![true, false, false, true]));

pub fn bitwise_bin_op_mut_or_clone<F>( self, rhs: &BooleanArray, op: F, ) -> BooleanArray

where F: FnMut(u64, u64) -> u64,

Apply a bitwise binary operation to this array and rhs in place if the buffer is uniquely owned, or clone and apply if shared.

This is a convenience wrapper around bitwise_bin_op_mut that falls back to bitwise_bin_op when the buffer is shared.

Null buffers are unioned: the result is null where either input is null.

Panics

Panics if self and rhs have different lengths.

Example

let a = BooleanArray::from(vec![true, false, true, true]);
let b = BooleanArray::from(vec![true, true, false, true]);
let result = a.bitwise_bin_op_mut_or_clone(&b, |a, b| a & b);
assert_eq!(result, BooleanArray::from(vec![true, false, false, true]));

fn try_bitwise_bin_op_in_place<F>( self, rhs: &BooleanArray, op: F, ) -> Result<BooleanArray, (BooleanArray, F)>

where F: FnMut(u64, u64) -> u64,

Try to apply a binary op in place. Returns op back on failure so callers can fall back to an allocating path without requiring F: Clone.

pub fn into_parts(self) -> (BooleanBuffer, Option<NullBuffer>)

Deconstruct this array into its constituent parts

impl<'a> BooleanArray

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

constructs a new iterator

impl BooleanArray

pub unsafe fn from_trusted_len_iter<I, P>(iter: I) -> Self

where P: Into<BooleanAdapter>, I: ExactSizeIterator<Item = P>,

Creates a BooleanArray from an iterator of trusted length.

Safety

The iterator must be TrustedLen. I.e. that size_hint().1 correctly reports its length. Note that this is a stronger guarantee that ExactSizeIterator provides which could still report a wrong length.

Panics

Panics if the iterator does not report an upper bound on size_hint().

Trait Implementations

impl Array for BooleanArray

SAFETY: Correctly implements the contract of Arrow Arrays

fn as_any(&self) -> &dyn Any

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

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 data_type(&self) -> &DataType

Returns a reference to the [DataType] of this array.

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

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

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

Shrinks the capacity of any exclusively owned buffer as much as possible

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 nulls(&self) -> Option<&NullBuffer>

Returns the null buffer of this array if any.

fn logical_null_count(&self) -> usize

Returns the total number of logical 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. Note that this does not always correspond to the exact memory usage of an array, since multiple arrays can share the same buffers or slices thereof.

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.

fn claim(&self, pool: &dyn MemoryPool)

Claim memory used by this array in the provided memory pool.

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

Returns a potentially computed [NullBuffer] that represents the logical null values of this array, if any.

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

Returns whether the element at index is null according to Array::nulls

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

Returns whether the element at index is not null, the opposite of Self::is_null.

fn null_count(&self) -> usize

Returns the total number of physical null values in this array.

fn is_nullable(&self) -> bool

Returns false if the array is guaranteed to not contain any logical nulls

impl ArrayAccessor for &BooleanArray

type Item = bool

The Arrow type of the element being accessed.

fn value(&self, index: usize) -> Self::Item

Returns the element at index i

unsafe fn value_unchecked(&self, index: usize) -> Self::Item

Returns the element at index i

impl Clone for BooleanArray

fn clone(&self) -> BooleanArray

Returns a duplicate 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 From<ArrayData> for BooleanArray

fn from(data: ArrayData) -> Self

Converts to this type from the input type.

impl From<BooleanArray> for ArrayData

fn from(array: BooleanArray) -> Self

Converts to this type from the input type.

impl From<BooleanBuffer> for BooleanArray

fn from(values: BooleanBuffer) -> Self

Converts to this type from the input type.

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

fn from(data: Vec<Option<bool>>) -> Self

Converts to this type from the input type.

impl From<Vec<bool>> for BooleanArray

fn from(data: Vec<bool>) -> Self

Converts to this type from the input type.

impl<Ptr: Into<BooleanAdapter>> 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 = ArrayIter<&'a BooleanArray>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for BooleanArray

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.