Struct arrow2::array::BooleanArray
source · [−]pub struct BooleanArray { /* private fields */ }
Expand description
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
sourceimpl BooleanArray
impl BooleanArray
sourcepub fn from_trusted_len_values_iter<I: TrustedLen<Item = bool>>(
iterator: I
) -> Self
pub fn from_trusted_len_values_iter<I: TrustedLen<Item = bool>>(
iterator: I
) -> Self
Creates a new BooleanArray
from an TrustedLen
of bool
.
sourcepub unsafe fn from_trusted_len_values_iter_unchecked<I: Iterator<Item = bool>>(
iterator: I
) -> Self
pub unsafe fn from_trusted_len_values_iter_unchecked<I: Iterator<Item = bool>>(
iterator: I
) -> Self
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.
sourcepub fn from_slice<P: AsRef<[bool]>>(slice: P) -> Self
pub fn from_slice<P: AsRef<[bool]>>(slice: P) -> Self
Creates a new BooleanArray
from a slice of bool
.
sourcepub unsafe fn from_trusted_len_iter_unchecked<I, P>(iterator: I) -> Self where
P: Borrow<bool>,
I: Iterator<Item = Option<P>>,
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.
sourcepub fn from_trusted_len_iter<I, P>(iterator: I) -> Self where
P: Borrow<bool>,
I: TrustedLen<Item = Option<P>>,
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
.
sourcepub 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>>,
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.
sourcepub 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>>,
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
.
sourceimpl<'a> BooleanArray
impl<'a> BooleanArray
sourcepub fn iter(&'a self) -> ZipValidity<'a, bool, BitmapIter<'a>>ⓘNotable traits for ZipValidity<'a, T, I>impl<'a, T, I: Iterator<Item = T>> Iterator for ZipValidity<'a, T, I> type Item = Option<T>;
pub fn iter(&'a self) -> ZipValidity<'a, bool, BitmapIter<'a>>ⓘNotable traits for ZipValidity<'a, T, I>impl<'a, T, I: Iterator<Item = T>> Iterator for ZipValidity<'a, T, I> type Item = Option<T>;
Returns an iterator over the optional values of this BooleanArray
.
sourcepub fn values_iter(&'a self) -> BitmapIter<'a>ⓘNotable traits for BitmapIter<'a>impl<'a> Iterator for BitmapIter<'a> type Item = bool;
pub fn values_iter(&'a self) -> BitmapIter<'a>ⓘNotable traits for BitmapIter<'a>impl<'a> Iterator for BitmapIter<'a> type Item = bool;
Returns an iterator over the values of this BooleanArray
sourceimpl BooleanArray
impl BooleanArray
sourcepub fn try_new(
data_type: DataType,
values: Bitmap,
validity: Option<Bitmap>
) -> Result<Self, ArrowError>
pub fn try_new(
data_type: DataType,
values: Bitmap,
validity: Option<Bitmap>
) -> Result<Self, 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 fromvalues
’s length - The
data_type
’sPhysicalType
is not equal toPhysicalType::Boolean
.
sourcepub fn new(
data_type: DataType,
values: Bitmap,
validity: Option<Bitmap>
) -> Self
pub fn new(
data_type: DataType,
values: Bitmap,
validity: Option<Bitmap>
) -> Self
The canonical method to create a BooleanArray
Panics
This function errors iff:
- The validity is not
None
and its length is different fromvalues
’s length - The
data_type
’sPhysicalType
is not equal toPhysicalType::Boolean
.
sourcepub fn from_data(
data_type: DataType,
values: Bitmap,
validity: Option<Bitmap>
) -> Self
pub fn from_data(
data_type: DataType,
values: Bitmap,
validity: Option<Bitmap>
) -> Self
Alias for new
sourcepub fn new_empty(data_type: DataType) -> Self
pub fn new_empty(data_type: DataType) -> Self
Returns a new empty BooleanArray
.
sourcepub fn new_null(data_type: DataType, length: usize) -> Self
pub fn new_null(data_type: DataType, length: usize) -> Self
Returns a new BooleanArray
whose all slots are null / None
.
sourceimpl BooleanArray
impl BooleanArray
sourcepub fn slice(&self, offset: usize, length: usize) -> Self
pub fn slice(&self, offset: usize, length: usize) -> Self
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()
.
sourcepub unsafe fn slice_unchecked(&self, offset: usize, length: usize) -> Self
pub unsafe fn slice_unchecked(&self, offset: usize, length: usize) -> Self
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()
.
sourcepub fn with_validity(&self, validity: Option<Bitmap>) -> Self
pub fn with_validity(&self, validity: Option<Bitmap>) -> Self
Sets the validity bitmap on this BooleanArray
.
Panic
This function panics iff validity.len() != self.len()
.
sourcepub fn into_mut(self) -> Either<Self, MutableBooleanArray>ⓘNotable traits for Either<L, R>impl<L, R> Read for Either<L, R> where
L: Read,
R: Read, impl<L, R> Iterator for Either<L, R> where
L: Iterator,
R: Iterator<Item = <L as Iterator>::Item>, type Item = <L as Iterator>::Item;impl<L, R> Write for Either<L, R> where
L: Write,
R: Write,
pub fn into_mut(self) -> Either<Self, MutableBooleanArray>ⓘNotable traits for Either<L, R>impl<L, R> Read for Either<L, R> where
L: Read,
R: Read, impl<L, R> Iterator for Either<L, R> where
L: Iterator,
R: Iterator<Item = <L as Iterator>::Item>, type Item = <L as Iterator>::Item;impl<L, R> Write for Either<L, R> where
L: Write,
R: Write,
L: Read,
R: Read, impl<L, R> Iterator for Either<L, R> where
L: Iterator,
R: Iterator<Item = <L as Iterator>::Item>, type Item = <L as Iterator>::Item;impl<L, R> Write for Either<L, R> where
L: Write,
R: Write,
Try to convert this BooleanArray
to a MutableBooleanArray
sourceimpl BooleanArray
impl BooleanArray
Trait Implementations
sourceimpl Array for BooleanArray
impl Array for BooleanArray
sourcefn data_type(&self) -> &DataType
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. Read more
sourcefn null_count(&self) -> usize
fn null_count(&self) -> usize
sourceimpl Clone for BooleanArray
impl Clone for BooleanArray
sourcefn clone(&self) -> BooleanArray
fn clone(&self) -> BooleanArray
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for BooleanArray
impl Debug for BooleanArray
sourceimpl<'a> From<GrowableBoolean<'a>> for BooleanArray
impl<'a> From<GrowableBoolean<'a>> for BooleanArray
sourcefn from(val: GrowableBoolean<'a>) -> Self
fn from(val: GrowableBoolean<'a>) -> Self
Converts to this type from the input type.
sourceimpl From<MutableBooleanArray> for BooleanArray
impl From<MutableBooleanArray> for BooleanArray
sourcefn from(other: MutableBooleanArray) -> Self
fn from(other: MutableBooleanArray) -> Self
Converts to this type from the input type.
sourceimpl<P: AsRef<[Option<bool>]>> From<P> for BooleanArray
impl<P: AsRef<[Option<bool>]>> From<P> for BooleanArray
sourcefn from(slice: P) -> Self
fn from(slice: P) -> Self
Creates a new BooleanArray
out of a slice of Optional bool
.
sourceimpl<Ptr: Borrow<Option<bool>>> FromIterator<Ptr> for BooleanArray
impl<Ptr: Borrow<Option<bool>>> FromIterator<Ptr> for BooleanArray
sourcefn from_iter<I: IntoIterator<Item = Ptr>>(iter: I) -> Self
fn from_iter<I: IntoIterator<Item = Ptr>>(iter: I) -> Self
Creates a value from an iterator. Read more
sourceimpl<'a> IntoIterator for &'a BooleanArray
impl<'a> IntoIterator for &'a BooleanArray
sourceimpl PartialEq<&'_ (dyn Array + '_)> for BooleanArray
impl PartialEq<&'_ (dyn Array + '_)> for BooleanArray
Auto Trait Implementations
impl RefUnwindSafe for BooleanArray
impl Send for BooleanArray
impl Sync for BooleanArray
impl Unpin for BooleanArray
impl UnwindSafe for BooleanArray
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more