Struct BoolVector 

pub struct BoolVector { /* private fields */ }

An immutable vector of boolean values.

Internally, this BoolVector is a wrapper around a BitBuffer and a validity mask.

Implementations

impl BoolVector

pub fn new(bits: BitBuffer, validity: Mask) -> Self

Creates a new BoolVector from the given bits and validity mask.

Panics

Panics if the length of the validity mask does not match the length of the bits.

pub fn try_new(bits: BitBuffer, validity: Mask) -> VortexResult<Self>

Tries to create a new BoolVector from the given bits and validity mask.

Errors

Returns an error if the length of the validity mask does not match the length of the bits.

pub unsafe fn new_unchecked(bits: BitBuffer, validity: Mask) -> Self

Creates a new BoolVector from the given bits and validity mask without validation.

Safety

The caller must ensure that the validity mask has the same length as the bits.

pub fn into_parts(self) -> (BitBuffer, Mask)

Decomposes the boolean vector into its constituent parts (bit buffer and validity).

pub fn bits(&self) -> &BitBuffer

Returns the bits buffer of the boolean vector.

pub fn into_bits(self) -> BitBuffer

Consumes the boolean vector and returns the bits buffer.

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

Gets a nullable element at the given index, panicking on out-of-bounds.

If the element at the given index is null, returns None. Otherwise, returns Some(x), where x: bool.

Note that this get method is different from the standard library slice::get, which returns None if the index is out of bounds. This method will panic if the index is out of bounds, and return None if the element is null.

Panics

Panics if the index is out of bounds.

Trait Implementations

impl Clone for BoolVector

fn clone(&self) -> BoolVector

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BoolVector

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

Formats the value using the given formatter.

impl From<BoolVector> for BoolDatum

fn from(val: BoolVector) -> Self

Converts to this type from the input type.

impl From<BoolVector> for Vector

fn from(v: BoolVector) -> Self

Converts to this type from the input type.

impl FromIterator<bool> for BoolVector

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = bool>,

Creates a new BoolVector from an iterator of bool values.

impl PartialEq for BoolVector

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl VectorOps for BoolVector

type Mutable = BoolVectorMut

The mutable equivalent of this immutable vector.

type Scalar = BoolScalar

The scalar type for this vector.

fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its “length”.

fn validity(&self) -> &Mask

Returns the validity mask of the vector, where true represents a valid element and false represents a null element.

fn mask_validity(&mut self, mask: &Mask)

Masks the validity of the vector with another validity mask. The resulting vector’s validity is the intersection of the two validity masks.

fn scalar_at(&self, index: usize) -> BoolScalar

Return the scalar at the given index.

fn slice(&self, range: impl RangeBounds<usize> + Clone + Debug) -> Self

Slice the vector from start to end (exclusive).

fn clear(&mut self)

Clears the vector of data, preserving any existing capacity where possible.

fn try_into_mut(self) -> Result<BoolVectorMut, Self>

Tries to convert self into a mutable vector (implementing VectorMutOps).

fn into_mut(self) -> BoolVectorMut

Converts self into a mutable vector (implementing VectorMutOps).

fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

fn null_count(&self) -> usize

Returns the null count of the vector.

impl Eq for BoolVector