Struct arrow::array::BooleanArray

pub struct BooleanArray {
    values: BooleanBuffer,
    nulls: Option<NullBuffer>,
}
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)])

Fields§

§values: BooleanBuffer§nulls: Option<NullBuffer>

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 new_null(len: usize) -> BooleanArray

Create a new BooleanArray with length len consisting only of nulls

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

Create a new Scalar from value

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

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

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) -> BooleanArray
where 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) -> BooleanArray
where 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

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

Deconstruct this array into its constituent parts

§

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

fn to_data(&self) -> ArrayData

Returns the underlying data of this array
§

fn into_data(self) -> ArrayData

Returns the underlying data of this array Read more
§

fn data_type(&self) -> &DataType

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

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
§

fn len(&self) -> usize

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

fn is_empty(&self) -> bool

Returns whether this array is empty. Read more
§

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
§

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

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

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

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

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

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

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

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

fn null_count(&self) -> usize

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

fn is_nullable(&self) -> bool

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

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 Read more
§

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

Returns the element at index i Read more
§

impl Clone for BooleanArray

§

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
§

impl Debug for BooleanArray

§

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

Formats the value using the given formatter. Read more
§

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<BooleanBuffer> for BooleanArray

§

fn from(values: BooleanBuffer) -> BooleanArray

Converts to this type from the input type.
§

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

§

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

Converts to this type from the input type.
§

impl From<Vec<bool>> for BooleanArray

§

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

Converts to this type from the input type.
§

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

§

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

Creates a value from an iterator. Read more
§

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

impl PartialEq for BooleanArray

§

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

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

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.

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
§

impl<T> Datum for T
where T: Array,

§

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 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> ToOwned for T
where 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 T
where 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 T
where 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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

§

impl<T> Ungil for T
where T: Send,