Struct arrow::array::BooleanArray

pub struct BooleanArray { /* fields omitted */ }

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

impl BooleanArray

pub fn len(&self) -> usize

Returns the length of this array.

pub fn is_empty(&self) -> bool

Returns whether this array is empty.

pub fn builder(capacity: usize) -> BooleanBuilder

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.

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

pub fn value(&self, i: usize) -> bool

Returns the boolean value at index i.

Panics of offset i is out of bounds

impl<'a> BooleanArray

pub fn iter(&'a self) -> BooleanIter<'a>

constructs a new iterator

Trait Implementations

impl Array for BooleanArray

fn as_any(&self) -> &dyn Any

Returns the array as Any so that it can be downcasted to a specific implementation.

fn data(&self) -> &ArrayData

Returns a reference to the underlying data of this array.

fn data_ref(&self) -> &ArrayData

Returns a reference-counted pointer to the underlying data of this array.

fn data_type(&self) -> &DataType

Returns a reference to the DataType of this array.

fn slice(&self, offset: usize, length: usize) -> ArrayRef

Returns a zero-copy slice of this array with the indicated offset and length.

fn len(&self) -> usize

Returns the length (i.e., number of elements) of this array.

fn is_empty(&self) -> bool

Returns whether this array is empty.

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.

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.

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.

fn null_count(&self) -> usize

Returns the total number of null values in this array.

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.

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.

fn to_raw(&self) -> Result<(*const FFI_ArrowArray, *const FFI_ArrowSchema)>

returns two pointers that represent this array in the C Data Interface (FFI)

impl Debug for BooleanArray

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

Formats the value using the given formatter.

impl From<ArrayData> for BooleanArray

fn from(data: ArrayData) -> Self

Performs the conversion.

impl From<Vec<Option<bool>, Global>> for BooleanArray

fn from(data: Vec<Option<bool>>) -> Self

Performs the conversion.

impl From<Vec<bool, Global>> for BooleanArray

fn from(data: Vec<bool>) -> Self

Performs the conversion.

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

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

Creates a value from an iterator.

impl<'a> IntoIterator for &'a BooleanArray

type Item = Option<bool>

The type of the elements being iterated over.

type IntoIter = BooleanIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl JsonEqual for BooleanArray

Implement array equals for numeric type

fn equals_json(&self, json: &[&Value]) -> bool

Checks whether arrow array equals to json array.

fn equals_json_values(&self, json: &[Value]) -> bool

Checks whether arrow array equals to json array.

impl PartialEq<BooleanArray> for BooleanArray

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