Struct polars::export::arrow::array::BooleanArray

pub struct BooleanArray { /* private fields */ }

The Arrow’s equivalent to an immutable Vec<Option<bool>>, but with 1/16 of its size. Cloning and slicing this struct is O(1).

Implementations

impl BooleanArray

pub fn from_trusted_len_values_iter<I>(iterator: I) -> BooleanArray where
    I: TrustedLen<Item = bool>, 

Creates a new BooleanArray from an TrustedLen of bool.

pub unsafe fn from_trusted_len_values_iter_unchecked<I>(
    iterator: I
) -> BooleanArray where
    I: Iterator<Item = bool>, 

Creates a new BooleanArray from an TrustedLen of bool. 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_slice<P>(slice: P) -> BooleanArray where
    P: AsRef<[bool]>, 

Creates a new BooleanArray from a slice of bool.

pub unsafe fn from_trusted_len_iter_unchecked<I, P>(iterator: I) -> BooleanArray 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) -> BooleanArray 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<BooleanArray, 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<BooleanArray, 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>>

Returns an iterator over the optional values of this BooleanArray.

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

Returns an iterator over the values of this BooleanArray

impl BooleanArray

pub fn try_new(
    data_type: DataType,
    values: Bitmap,
    validity: Option<Bitmap>
) -> Result<BooleanArray, ArrowError>

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

Errors

This function errors iff:

• The validity is not None and its length is different from values’s length
• The data_type’s PhysicalType is not equal to PhysicalType::Boolean.

pub fn new(
    data_type: DataType,
    values: Bitmap,
    validity: Option<Bitmap>
) -> BooleanArray

The canonical method to create a BooleanArray

Panics

This function errors iff:

• The validity is not None and its length is different from values’s length
• The data_type’s PhysicalType is not equal to PhysicalType::Boolean.

pub fn from_data(
    data_type: DataType,
    values: Bitmap,
    validity: Option<Bitmap>
) -> BooleanArray

Alias for new

pub fn new_empty(data_type: DataType) -> BooleanArray

Returns a new empty BooleanArray.

pub fn new_null(data_type: DataType, length: usize) -> BooleanArray

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

impl BooleanArray

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

Returns a slice of this BooleanArray.

Implementation

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

Panic

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

pub unsafe fn slice_unchecked(
    &self,
    offset: usize,
    length: usize
) -> BooleanArray

Returns a slice of this BooleanArray.

Implementation

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

Safety

The caller must ensure that offset + length <= self.len().

pub fn with_validity(&self, validity: Option<Bitmap>) -> BooleanArray

Sets the validity bitmap on this BooleanArray.

Panic

This function panics iff validity.len() != self.len().

pub fn into_mut(self) -> Either<BooleanArray, MutableBooleanArray>

Try to convert this BooleanArray to a MutableBooleanArray

impl BooleanArray

pub fn len(&self) -> usize

Returns the length of this array

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

Returns the value at index i

Panic

This function panics iff i >= self.len().

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 validity(&self) -> Option<&Bitmap>

The optional validity.

pub fn values(&self) -> &Bitmap

Returns the values of this BooleanArray.

Trait Implementations

impl Array for BooleanArray

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

Convert to trait object.

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 + 'static, Global>

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

unsafe fn slice_unchecked(
    &self,
    offset: usize,
    length: usize
) -> Box<dyn Array + 'static, Global>

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

fn with_validity(
    &self,
    validity: Option<Bitmap>
) -> Box<dyn Array + 'static, Global>

Sets the validity bitmap on this Array.

fn is_empty(&self) -> bool

whether the array is empty

fn null_count(&self) -> usize

The number of null slots on this Array.

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 ChunkApplyKernel<BooleanArray> for ChunkedArray<BooleanType>

fn apply_kernel(&self, f: &dyn Fn(&BooleanArray)) -> ChunkedArray<BooleanType>

Apply kernel and return result as a new ChunkedArray.

fn apply_kernel_cast<S>(&self, f: &dyn Fn(&BooleanArray)) -> ChunkedArray<S> where
    S: PolarsDataType, 

Apply a kernel that outputs an array of different type.

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<BooleanArray> for ChunkedArray<BooleanType>

fn from(arr: BooleanArray) -> ChunkedArray<BooleanType>

Performs the conversion.

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

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

Performs the conversion.

impl From<MutableBooleanArray> for BooleanArray

fn from(other: MutableBooleanArray) -> BooleanArray

Performs the conversion.

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

fn from(slice: P) -> BooleanArray

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

impl FromData<Bitmap> for BooleanArray

fn from_data_default(values: Bitmap, validity: Option<Bitmap>) -> BooleanArray

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.

impl FromTrustedLenIterator<Option<bool>> for BooleanArray

fn from_iter_trusted_length<I>(iter: I) -> BooleanArray where
    I: IntoIterator<Item = Option<bool>>,
    <I as IntoIterator>::IntoIter: TrustedLen, 

impl FromTrustedLenIterator<bool> for BooleanArray

fn from_iter_trusted_length<I>(iter: I) -> BooleanArray where
    I: IntoIterator<Item = bool>,
    <I as IntoIterator>::IntoIter: TrustedLen, 

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) -> <&'a BooleanArray as IntoIterator>::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: &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 !=.

impl ArrowArray for BooleanArray