Struct arrow::array::BooleanArray
source · [−]pub struct BooleanArray { /* private fields */ }
Expand description
Array of bools
Example
use arrow::array::{Array, BooleanArray};
let arr = BooleanArray::from(vec![Some(false), Some(true), None, Some(true)]);
assert_eq!(4, arr.len());
assert_eq!(1, arr.null_count());
assert!(arr.is_valid(0));
assert!(!arr.is_null(0));
assert_eq!(false, arr.value(0));
assert!(arr.is_valid(1));
assert!(!arr.is_null(1));
assert_eq!(true, arr.value(1));
assert!(!arr.is_valid(2));
assert!(arr.is_null(2));
assert!(arr.is_valid(3));
assert!(!arr.is_null(3));
assert_eq!(true, arr.value(3));
Using from_iter
use arrow::array::{Array, BooleanArray};
let v = vec![Some(false), Some(true), Some(false), Some(true)];
let arr = v.into_iter().collect::<BooleanArray>();
assert_eq!(4, arr.len());
assert_eq!(0, arr.offset());
assert_eq!(0, arr.null_count());
assert!(arr.is_valid(0));
assert_eq!(false, arr.value(0));
assert!(arr.is_valid(1));
assert_eq!(true, arr.value(1));
assert!(arr.is_valid(2));
assert_eq!(false, arr.value(2));
assert!(arr.is_valid(3));
assert_eq!(true, arr.value(3));
Implementations
sourceimpl BooleanArray
impl BooleanArray
pub fn builder(capacity: usize) -> BooleanBuilder
sourcepub fn values(&self) -> &Buffer
pub fn values(&self) -> &Buffer
Returns a Buffer
holding all the values of this array.
Note this doesn’t take the offset of this array into account.
sourcepub unsafe fn value_unchecked(&self, i: usize) -> bool
pub unsafe fn value_unchecked(&self, i: usize) -> bool
Returns the boolean value at index i
.
Safety
This doesn’t check bounds, the caller must ensure that index < self.len()
sourceimpl<'a> BooleanArray
impl<'a> BooleanArray
sourcepub fn iter(&'a self) -> BooleanIter<'a>ⓘNotable traits for BooleanIter<'a>impl<'a> Iterator for BooleanIter<'a> type Item = Option<bool>;
pub fn iter(&'a self) -> BooleanIter<'a>ⓘNotable traits for BooleanIter<'a>impl<'a> Iterator for BooleanIter<'a> type Item = Option<bool>;
constructs a new iterator
Trait Implementations
sourceimpl Array for BooleanArray
impl Array for BooleanArray
sourcefn data_ref(&self) -> &ArrayData
fn data_ref(&self) -> &ArrayData
Returns a reference-counted pointer to the underlying data of this array.
sourcefn slice(&self, offset: usize, length: usize) -> ArrayRef
fn slice(&self, offset: usize, length: usize) -> ArrayRef
Returns a zero-copy slice of this array with the indicated offset and length. Read more
sourcefn offset(&self) -> usize
fn offset(&self) -> usize
Returns the offset into the underlying data used by this array(-slice).
Note that the underlying data can be shared by many arrays.
This defaults to 0
. Read more
sourcefn is_null(&self, index: usize) -> bool
fn is_null(&self, index: usize) -> bool
Returns whether the element at index
is null.
When using this function on a slice, the index is relative to the slice. Read more
sourcefn is_valid(&self, index: usize) -> bool
fn is_valid(&self, index: usize) -> bool
Returns whether the element at index
is not null.
When using this function on a slice, the index is relative to the slice. Read more
sourcefn null_count(&self) -> usize
fn null_count(&self) -> usize
Returns the total number of null values in this array. Read more
sourcefn get_buffer_memory_size(&self) -> usize
fn get_buffer_memory_size(&self) -> usize
Returns the total number of bytes of memory pointed to by this array. The buffers store bytes in the Arrow memory format, and include the data as well as the validity map. Read more
sourcefn get_array_memory_size(&self) -> usize
fn get_array_memory_size(&self) -> usize
Returns the total number of bytes of memory occupied physically by this array.
This value will always be greater than returned by get_buffer_memory_size()
and
includes the overhead of the data structures that contain the pointers to the various buffers. Read more
sourcefn to_raw(&self) -> Result<(*const FFI_ArrowArray, *const FFI_ArrowSchema)>
fn to_raw(&self) -> Result<(*const FFI_ArrowArray, *const FFI_ArrowSchema)>
returns two pointers that represent this array in the C Data Interface (FFI)
sourceimpl Debug for BooleanArray
impl Debug for BooleanArray
sourceimpl From<ArrayData> for BooleanArray
impl From<ArrayData> for BooleanArray
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 JsonEqual for BooleanArray
impl JsonEqual for BooleanArray
Implement array equals for numeric type
sourceimpl PartialEq<BooleanArray> for BooleanArray
impl PartialEq<BooleanArray> 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 · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more