Struct polars_arrow::array::MutableBooleanArray

pub struct MutableBooleanArray { /* private fields */ }

The Arrow’s equivalent to Vec<Option<bool>>, but with 1/16 of its size. Converting a MutableBooleanArray into a BooleanArray is O(1).

Implementation

This struct does not allocate a validity until one is required (i.e. push a null to it).

Implementations

impl<'a> MutableBooleanArray

pub fn iter(&'a self) -> ZipValidity<bool, BitmapIter<'a>, BitmapIter<'a>>

Returns an iterator over the optional values of this MutableBooleanArray.

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

Returns an iterator over the values of this MutableBooleanArray

impl MutableBooleanArray

pub fn new() -> Self

Creates an new empty MutableBooleanArray.

pub fn try_new( data_type: ArrowDataType, values: MutableBitmap, validity: Option<MutableBitmap>, ) -> PolarsResult<Self>

The canonical method to create a MutableBooleanArray 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 with_capacity(capacity: usize) -> Self

Creates an new MutableBooleanArray with a capacity of values.

pub fn reserve(&mut self, additional: usize)

Reserves additional slots.

pub fn push_value(&mut self, value: bool)

pub fn push_null(&mut self)

pub fn push(&mut self, value: Option<bool>)

Pushes a new entry to MutableBooleanArray.

pub fn pop(&mut self) -> Option<bool>

Pop an entry from MutableBooleanArray. Note If the values is empty, this method will return None.

pub fn extend_trusted_len_values<I>(&mut self, iterator: I)

where I: TrustedLen<Item = bool>,

Extends the MutableBooleanArray from an iterator of values of trusted len. This differs from extend_trusted_len which accepts in iterator of optional values.

pub unsafe fn extend_trusted_len_values_unchecked<I>(&mut self, iterator: I)

where I: Iterator<Item = bool>,

Extends the MutableBooleanArray from an iterator of values of trusted len. This differs from extend_trusted_len_unchecked, which accepts in iterator of optional values.

Safety

The iterator must be trusted len.

pub fn extend_trusted_len<I, P>(&mut self, iterator: I)

where P: Borrow<bool>, I: TrustedLen<Item = Option<P>>,

Extends the MutableBooleanArray from an iterator of trusted len.

pub unsafe fn extend_trusted_len_unchecked<I, P>(&mut self, iterator: I)

where P: Borrow<bool>, I: Iterator<Item = Option<P>>,

Extends the MutableBooleanArray from an iterator of trusted len.

Safety

The iterator must be trusted len.

pub fn extend_constant(&mut self, additional: usize, value: Option<bool>)

Extends MutableBooleanArray by additional values of constant value.

pub fn into_arc(self) -> Arc<dyn Array>

Converts itself into an Array.

pub fn freeze(self) -> BooleanArray

impl MutableBooleanArray

Getters

pub fn values(&self) -> &MutableBitmap

Returns its values.

impl MutableBooleanArray

Setters

pub fn set(&mut self, index: usize, value: Option<bool>)

Sets position index to value. Note that if it is the first time a null appears in this array, this initializes the validity bitmap (O(N)).

Panic

Panics iff index is larger than self.len().

impl MutableBooleanArray

From implementations

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

Creates a new MutableBooleanArray from an TrustedLen of bool.

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

Creates a new MutableBooleanArray 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: AsRef<[bool]>>(slice: P) -> Self

Creates a new MutableBooleanArray from a slice of bool.

pub unsafe fn from_trusted_len_iter_unchecked<I, P>(iterator: I) -> Self

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

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<Self, 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<Self, E>

where P: Borrow<bool>, I: TrustedLen<Item = Result<Option<P>, E>>,

Creates a BooleanArray from a TrustedLen.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the MutableBooleanArray to fit its current length.

Trait Implementations

impl Clone for MutableBooleanArray

fn clone(&self) -> MutableBooleanArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MutableBooleanArray

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

Formats the value using the given formatter.

impl Default for MutableBooleanArray

fn default() -> Self

Returns the “default value” for a type.

impl Extend<Option<bool>> for MutableBooleanArray

fn extend<I: IntoIterator<Item = Option<bool>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<MutableBooleanArray> for BooleanArray

fn from(other: MutableBooleanArray) -> Self

Converts to this type from the input type.

impl<P: AsRef<[Option<bool>]>> From<P> for MutableBooleanArray

fn from(slice: P) -> Self

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

impl<Ptr: Borrow<Option<bool>>> FromIterator<Ptr> for MutableBooleanArray

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

Creates a value from an iterator.

impl<'a> IntoIterator for &'a MutableBooleanArray

type Item = Option<bool>

The type of the elements being iterated over.

type IntoIter = ZipValidity<bool, BitmapIter<'a>, BitmapIter<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl MutableArray for MutableBooleanArray

fn len(&self) -> usize

The length of the array.

fn validity(&self) -> Option<&MutableBitmap>

The optional validity of the array.

fn as_box(&mut self) -> Box<dyn Array>

Convert itself to an (immutable) Array.

fn as_arc(&mut self) -> Arc<dyn Array>

Convert itself to an (immutable) atomically reference counted Array.

fn data_type(&self) -> &ArrowDataType

The ArrowDataType of the array.

fn as_any(&self) -> &dyn Any

Convert to Any, to enable dynamic casting.

fn as_mut_any(&mut self) -> &mut dyn Any

Convert to mutable Any, to enable dynamic casting.

fn push_null(&mut self)

Adds a new null element to the array.

fn reserve(&mut self, additional: usize)

Reserves additional slots to its capacity.

fn shrink_to_fit(&mut self)

Shrink the array to fit its length.

fn is_empty(&self) -> bool

Whether the array is empty.

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

Whether index is valid / set.

impl PartialEq for MutableBooleanArray

fn eq(&self, other: &Self) -> 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.

impl Pushable<Option<bool>> for MutableBooleanArray

type Freeze = BooleanArray

fn reserve(&mut self, additional: usize)

fn push(&mut self, value: Option<bool>)

fn len(&self) -> usize

fn push_null(&mut self)

fn extend_constant(&mut self, additional: usize, value: Option<bool>)

fn extend_null_constant(&mut self, additional: usize)

fn freeze(self) -> Self::Freeze

fn with_capacity(capacity: usize) -> Self

impl Pushable<bool> for MutableBooleanArray

type Freeze = BooleanArray

fn reserve(&mut self, additional: usize)

fn push(&mut self, value: bool)

fn len(&self) -> usize

fn push_null(&mut self)

fn extend_constant(&mut self, additional: usize, value: bool)

fn extend_null_constant(&mut self, _additional: usize)

fn freeze(self) -> Self::Freeze

fn with_capacity(capacity: usize) -> Self

impl TryExtend<Option<bool>> for MutableBooleanArray

fn try_extend<I: IntoIterator<Item = Option<bool>>>( &mut self, iter: I, ) -> PolarsResult<()>

This is infalible and is implemented for consistency with all other types

impl TryExtendFromSelf for MutableBooleanArray

fn try_extend_from_self(&mut self, other: &Self) -> PolarsResult<()>

Tries to extend itself with elements from other, failing only on overflow.

impl TryPush<Option<bool>> for MutableBooleanArray

fn try_push(&mut self, item: Option<bool>) -> PolarsResult<()>

This is infalible and is implemented for consistency with all other types