Struct narrow::array::BooleanArray

pub struct BooleanArray<const NULLABLE: bool = false, Buffer: BufferType = VecBuffer>(_)
where
    Bitmap<Buffer>: Validity<NULLABLE>;

Array with boolean values.

Values are stored using single bits in a Bitmap.

Trait Implementations

impl<Buffer: BufferType> BitmapRef for BooleanArray<true, Buffer>

type Buffer = Buffer

The buffer type of the bitmap.

fn bitmap_ref(&self) -> &Bitmap<Self::Buffer>

Returns a reference to an immutable Bitmap.

impl<Buffer: BufferType> BitmapRefMut for BooleanArray<true, Buffer>

fn bitmap_ref_mut(&mut self) -> &mut Bitmap<Self::Buffer>

Returns a mutable reference to a Bitmap.

impl<const NULLABLE: bool, Buffer: BufferType> Default for BooleanArray<NULLABLE, Buffer>where Bitmap<Buffer>: Validity<NULLABLE>, <Bitmap<Buffer> as Validity<NULLABLE>>::Storage<Buffer>: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<U, const NULLABLE: bool, Buffer: BufferType> Extend<U> for BooleanArray<NULLABLE, Buffer>where Bitmap<Buffer>: Validity<NULLABLE>, <Bitmap<Buffer> as Validity<NULLABLE>>::Storage<Buffer>: Extend<U>,

fn extend<I: IntoIterator<Item = U>>(&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<const NULLABLE: bool, U, Buffer: BufferType> FromIterator<U> for BooleanArray<NULLABLE, Buffer>where Bitmap<Buffer>: Validity<NULLABLE>, <Bitmap<Buffer> as Validity<NULLABLE>>::Storage<Buffer>: FromIterator<U>,

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

Creates a value from an iterator.

impl<'a, const NULLABLE: bool, Buffer: BufferType> IntoIterator for &'a BooleanArray<NULLABLE, Buffer>where Bitmap<Buffer>: Validity<NULLABLE>, &'a <Bitmap<Buffer> as Validity<NULLABLE>>::Storage<Buffer>: IntoIterator,

type Item = <&'a <Bitmap<Buffer> as Validity<NULLABLE>>::Storage<Buffer> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <&'a <Bitmap<Buffer> as Validity<NULLABLE>>::Storage<Buffer> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const NULLABLE: bool, Buffer: BufferType> IntoIterator for BooleanArray<NULLABLE, Buffer>where Bitmap<Buffer>: Validity<NULLABLE>, <Bitmap<Buffer> as Validity<NULLABLE>>::Storage<Buffer>: IntoIterator,

type Item = <<Bitmap<Buffer> as Validity<NULLABLE>>::Storage<Buffer> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <<Bitmap<Buffer> as Validity<NULLABLE>>::Storage<Buffer> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const NULLABLE: bool, Buffer: BufferType> Length for BooleanArray<NULLABLE, Buffer>where Bitmap<Buffer>: Validity<NULLABLE>, <Bitmap<Buffer> as Validity<NULLABLE>>::Storage<Buffer>: Length,

fn len(&self) -> usize

Returns the number of elements in the collection, also referred to as its length.

fn is_empty(&self) -> bool

Returns true if there are no elements in the collection.

impl<Buffer: BufferType> ValidityBitmap for BooleanArray<true, Buffer>

fn is_null(&self, index: usize) -> Option<bool>

Returns true if the element at position index is null.

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

Returns true if the element at position index is null, without performing any bounds checking.

fn null_count(&self) -> usize

Returns the number of null elements.

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

Returns true if the element at position index is valid.

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

Returns true if the element at position index is valid, without performing any bounds checking.

fn valid_count(&self) -> usize

Returns the number of valid elements.

fn any_null(&self) -> bool

Returns true if the array contains at least one null element.

fn all_null(&self) -> bool

Returns true if all the elements are null.

fn any_valid(&self) -> bool

Returns true if the array contains at least one valid element.

fn all_valid(&self) -> bool

Returns true if all the elements are valid.

impl<const NULLABLE: bool, Buffer: BufferType> Array for BooleanArray<NULLABLE, Buffer>where Bitmap<Buffer>: Validity<NULLABLE>,