Enum Validity 

pub enum Validity {
    AllValid,
    AllInvalid,
    Mask(Bitmap),
}

Which values in a vector are valid.

Variants

AllValid

Nothing is null. No mask is stored and the kernels that read this take the fast path.

AllInvalid

Everything is null. Most operators can answer without looking at the data at all.

Mask(Bitmap)

Some of each, one bit per value, set meaning valid.

Implementations

impl Validity

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

Whether the value at index is not null.

Out of range reads report invalid rather than panicking, because this is called from kernels that are allowed to read past the end of a partially filled vector.

pub fn has_nulls(&self, len: usize) -> bool

Whether any value in the first len is null.

pub fn count_valid(&self, len: usize) -> usize

How many of the first len values are not null.

pub fn normalize(self, len: usize) -> Self

Collapses a mask that turned out to be uniform back to one of the flag cases.

Worth doing at the end of any operation that builds a mask, because every kernel downstream then gets to take the branch it wants rather than walking a bitmap to find out what it already could have been told.

pub fn with_null(self, index: usize, len: usize) -> Self

The validity of a vector where index has just been made null.

Takes and returns by value because setting a null on an AllValid vector has to materialize a mask, and hiding that behind &mut self hides an allocation.

pub fn from_iter(len: usize, valid: impl Fn(usize) -> bool) -> Self

Validity built from a per-value predicate, normalized.

pub fn and(&self, other: &Self, len: usize) -> Self

The validity of a value that is valid in both inputs, which is what almost every binary operator wants and is worth having in one place.

Trait Implementations

impl Clone for Validity

fn clone(&self) -> Validity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Validity

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

Formats the value using the given formatter.

impl Eq for Validity

impl PartialEq for Validity

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Validity