Struct arrow2::array::MutableBooleanArray

pub struct MutableBooleanArray { /* fields omitted */ }

The mutable version of BooleanArray. See MutableArray for more details.

Implementations

impl MutableBooleanArray

pub fn new() -> Self

pub fn with_capacity(capacity: usize) -> Self

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

pub fn from_data(values: MutableBitmap, validity: Option<MutableBitmap>) -> Self

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

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

Converts itself into an Array.

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

Trait Implementations

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

Performs the conversion.

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 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_arc(&mut self) -> Arc<dyn Array>

Convert itself to an (immutable) Array.

fn data_type(&self) -> &DataType

The DataType 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 is_empty(&self) -> bool

Whether the array is empty.

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

Whether index is valid / set.

impl TryExtend<Option<bool>> for MutableBooleanArray

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

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