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
impl BooleanArray
impl BooleanArray
pub fn from_trusted_len_values_iter<I>(iterator: I) -> BooleanArray where
I: TrustedLen<Item = bool>,
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>,
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]>,
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>>,
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>>,
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>>,
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>>,
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
impl<'a> BooleanArray
pub fn iter(&'a self) -> ZipValidity<'a, bool, BitmapIter<'a>>ⓘNotable traits for ZipValidity<'a, T, I>impl<'a, T, I> Iterator for ZipValidity<'a, T, I> where
I: Iterator<Item = T>, 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 for ZipValidity<'a, T, I> where
I: Iterator<Item = T>, type Item = Option<T>;
I: Iterator<Item = T>, type Item = Option<T>;
Returns an iterator over the optional values of this BooleanArray
.
pub 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
impl BooleanArray
impl BooleanArray
pub fn try_new(
data_type: DataType,
values: Bitmap,
validity: Option<Bitmap>
) -> Result<BooleanArray, ArrowError>
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 fromvalues
’s length - The
data_type
’sPhysicalType
is not equal toPhysicalType::Boolean
.
pub fn new(
data_type: DataType,
values: Bitmap,
validity: Option<Bitmap>
) -> BooleanArray
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 fromvalues
’s length - The
data_type
’sPhysicalType
is not equal toPhysicalType::Boolean
.
pub fn from_data(
data_type: DataType,
values: Bitmap,
validity: Option<Bitmap>
) -> BooleanArray
pub fn from_data(
data_type: DataType,
values: Bitmap,
validity: Option<Bitmap>
) -> BooleanArray
Alias for new
pub fn new_empty(data_type: DataType) -> BooleanArray
pub fn new_empty(data_type: DataType) -> BooleanArray
Returns a new empty BooleanArray
.
pub fn new_null(data_type: DataType, length: usize) -> BooleanArray
pub fn new_null(data_type: DataType, length: usize) -> BooleanArray
Returns a new BooleanArray
whose all slots are null / None
.
impl BooleanArray
impl BooleanArray
pub fn slice(&self, offset: usize, length: usize) -> 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
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
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>ⓘNotable traits for Either<L, R>impl<L, R> Write for Either<L, R> where
L: Write,
R: Write, 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;
pub fn into_mut(self) -> Either<BooleanArray, MutableBooleanArray>ⓘNotable traits for Either<L, R>impl<L, R> Write for Either<L, R> where
L: Write,
R: Write, 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;
L: Write,
R: Write, 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;
Try to convert this BooleanArray
to a MutableBooleanArray
impl BooleanArray
impl BooleanArray
pub unsafe fn value_unchecked(&self, i: usize) -> bool
pub unsafe fn value_unchecked(&self, i: usize) -> bool
pub fn values(&self) -> &Bitmap
pub fn values(&self) -> &Bitmap
Returns the values of this BooleanArray
.
Trait Implementations
impl Array for BooleanArray
impl Array for BooleanArray
fn 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
fn to_boxed(&self) -> Box<dyn Array + 'static, Global>
fn to_boxed(&self) -> Box<dyn Array + 'static, Global>
Clone a &dyn Array
to an owned Box<dyn Array>
.
fn null_count(&self) -> usize
fn null_count(&self) -> usize
impl ArrowGetItem for BooleanArray
impl ArrowGetItem for BooleanArray
type Item = bool
fn get(&self, item: usize) -> Option<<BooleanArray as ArrowGetItem>::Item>
unsafe fn get_unchecked(
&self,
item: usize
) -> Option<<BooleanArray as ArrowGetItem>::Item>
unsafe fn get_unchecked(
&self,
item: usize
) -> Option<<BooleanArray as ArrowGetItem>::Item>
Safety Read more
sourceimpl ChunkApplyKernel<BooleanArray> for ChunkedArray<BooleanType>
impl ChunkApplyKernel<BooleanArray> for ChunkedArray<BooleanType>
sourcefn apply_kernel(&self, f: &dyn Fn(&BooleanArray)) -> ChunkedArray<BooleanType>
fn apply_kernel(&self, f: &dyn Fn(&BooleanArray)) -> ChunkedArray<BooleanType>
Apply kernel and return result as a new ChunkedArray.
sourcefn apply_kernel_cast<S>(&self, f: &dyn Fn(&BooleanArray)) -> ChunkedArray<S> where
S: PolarsDataType,
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
impl Clone for BooleanArray
fn 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
impl Debug for BooleanArray
impl Debug for BooleanArray
sourceimpl From<BooleanArray> for ChunkedArray<BooleanType>
impl From<BooleanArray> for ChunkedArray<BooleanType>
sourcefn from(arr: BooleanArray) -> ChunkedArray<BooleanType>
fn from(arr: BooleanArray) -> ChunkedArray<BooleanType>
Converts to this type from the input type.
impl<'a> From<GrowableBoolean<'a>> for BooleanArray
impl<'a> From<GrowableBoolean<'a>> for BooleanArray
fn from(val: GrowableBoolean<'a>) -> BooleanArray
fn from(val: GrowableBoolean<'a>) -> BooleanArray
Converts to this type from the input type.
impl From<MutableBooleanArray> for BooleanArray
impl From<MutableBooleanArray> for BooleanArray
fn from(other: MutableBooleanArray) -> BooleanArray
fn from(other: MutableBooleanArray) -> BooleanArray
Converts to this type from the input type.
impl<P> From<P> for BooleanArray where
P: AsRef<[Option<bool>]>,
impl<P> From<P> for BooleanArray where
P: AsRef<[Option<bool>]>,
fn from(slice: P) -> BooleanArray
fn from(slice: P) -> BooleanArray
Creates a new BooleanArray
out of a slice of Optional bool
.
impl FromData<Bitmap> for BooleanArray
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>>,
impl<Ptr> FromIterator<Ptr> for BooleanArray where
Ptr: Borrow<Option<bool>>,
fn from_iter<I>(iter: I) -> BooleanArray where
I: IntoIterator<Item = Ptr>,
fn from_iter<I>(iter: I) -> BooleanArray where
I: IntoIterator<Item = Ptr>,
Creates a value from an iterator. Read more
impl FromTrustedLenIterator<Option<bool>> for BooleanArray
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
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
impl<'a> IntoIterator for &'a BooleanArray
type IntoIter = ZipValidity<'a, bool, BitmapIter<'a>>
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
fn into_iter(self) -> <&'a BooleanArray as IntoIterator>::IntoIter
Creates an iterator from a value. Read more
impl<'_> PartialEq<&'_ (dyn Array + '_)> for BooleanArray
impl<'_> PartialEq<&'_ (dyn Array + '_)> for BooleanArray
impl PartialEq<BooleanArray> for BooleanArray
impl PartialEq<BooleanArray> for BooleanArray
impl ArrowArray 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
impl<A> IsValid for A where
A: ArrowArray,
impl<A> IsValid for A where
A: ArrowArray,
unsafe fn is_valid_unchecked(&self, i: usize) -> bool
unsafe fn is_valid_unchecked(&self, i: usize) -> bool
Safety Read more
unsafe fn is_null_unchecked(&self, i: usize) -> bool
unsafe fn is_null_unchecked(&self, i: usize) -> bool
Safety Read more
impl<T> Pointable for T
impl<T> Pointable for T
impl<A> PolarsArray for A where
A: Array + ?Sized,
impl<A> PolarsArray for A where
A: Array + ?Sized,
fn has_validity(&self) -> bool
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