# Struct arrow::array::BooleanArray

``pub struct BooleanArray { /* private fields */ }``
Expand description

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)])``````

## Implementations§

source§

### impl BooleanArray

source

#### 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()`

source

#### pub fn new_null(len: usize) -> BooleanArray

Create a new `BooleanArray` with length `len` consisting only of nulls

source

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

Create a new `Scalar` from `value`

source

#### pub fn len(&self) -> usize

Returns the length of this array.

source

#### pub fn is_empty(&self) -> bool

Returns whether this array is empty.

source

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

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

source

#### pub fn builder(capacity: usize) -> BooleanBuilder

Returns a new boolean array builder

source

#### pub fn values(&self) -> &BooleanBuffer

Returns the underlying `BooleanBuffer` holding all the values of this array

source

#### pub fn true_count(&self) -> usize

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

source

#### pub fn false_count(&self) -> usize

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

source

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

source

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

Returns the boolean value at index `i`.

##### §Panics

Panics if index `i` is out of bounds

source

#### 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`

source

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

source

#### 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]));``````
source

#### 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

source

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

Deconstruct this array into its constituent parts

source§

### impl<'a> BooleanArray

source

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

constructs a new iterator

## Trait Implementations§

source§

### impl Array for BooleanArray

source§

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

Returns the array as `Any` so that it can be downcasted to a specific implementation. Read more
source§

#### fn to_data(&self) -> ArrayData

Returns the underlying data of this array
source§

#### fn into_data(self) -> ArrayData

Returns the underlying data of this array Read more
source§

#### fn data_type(&self) -> &DataType

Returns a reference to the `DataType` of this array. Read more
source§

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

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

#### fn len(&self) -> usize

Returns the length (i.e., number of elements) of this array. Read more
source§

#### fn is_empty(&self) -> bool

Returns whether this array is empty. Read more
source§

#### 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`. Read more
source§

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

Returns the null buffer of this array if any. Read more
source§

#### 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.
source§

#### 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.
source§

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

Returns a potentially computed `NullBuffer` that represents the logical null values of this array, if any. Read more
source§

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

Returns whether the element at `index` is null according to `Array::nulls` Read more
source§

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

Returns whether the element at `index` is not null, the opposite of `Self::is_null`. Read more
source§

#### fn null_count(&self) -> usize

Returns the total number of physical null values in this array. Read more
source§

#### fn is_nullable(&self) -> bool

Returns `false` if the array is guaranteed to not contain any logical nulls Read more
source§

### impl<'a> ArrayAccessor for &'a BooleanArray

§

#### type Item = bool

The Arrow type of the element being accessed.
source§

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

Returns the element at index `i` Read more
source§

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

Returns the element at index `i` Read more
source§

### impl Clone for BooleanArray

source§

#### fn clone(&self) -> BooleanArray

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for BooleanArray

source§

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

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

### impl From<ArrayData> for BooleanArray

source§

#### fn from(data: ArrayData) -> BooleanArray

Converts to this type from the input type.
source§

### impl From<BooleanArray> for ArrayData

source§

#### fn from(array: BooleanArray) -> ArrayData

Converts to this type from the input type.
source§

### impl From<BooleanBuffer> for BooleanArray

source§

#### fn from(values: BooleanBuffer) -> BooleanArray

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Creates a value from an iterator. Read more
source§

### 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?
source§

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

Creates an iterator from a value. Read more
source§

### impl PartialEq for BooleanArray

source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

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

§

§

§

§

§

§

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> CloneToUninit for Twhere T: Clone,

source§

#### default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dst`. Read more
source§

### impl<T> Datum for Twhere T: Array,

source§

#### fn get(&self) -> (&dyn Array, bool)

Returns the value for this `Datum` and a boolean indicating if the value is scalar
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere 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> ToOwned for Twhere T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### 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 Twhere U: TryFrom<T>,

§

#### 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.
source§