Struct Validity 

pub struct Validity(/* private fields */);

An optional validity mask. None (the dense default) means every value is present with no allocation; Some carries a Bitmap with at least one missing value. The invariant “Some ⇒ has a missing value” is upheld by the constructors so equality and has_nulls stay cheap and canonical.

Implementations

impl Validity

pub fn dense() -> Validity

A fully-present (dense) validity — no allocation.

pub fn from_bitmap(bm: Bitmap) -> Validity

Wrap a bitmap, collapsing an all-present one back to dense so the dense fast path is always taken when there are no missing values.

pub fn from_valid_iter( len: usize, valid: impl IntoIterator<Item = bool>, ) -> Validity

Build from an iterator of valid flags; dense when all are present.

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

Whether element i is present. Dense ⇒ always true. i in bounds.

pub fn has_nulls(&self) -> bool

Whether any value is missing (cheap: dense ⇒ false).

pub fn null_count(&self) -> usize

Number of missing values (dense ⇒ 0).

pub fn bitmap(&self) -> Option<&Bitmap>

Borrow the backing bitmap, if any (None when dense).

pub fn and(&self, other: &Validity) -> Validity

Combined validity of two equal-length columns: present only where both are present — the missing-value rule for a binary op (x ∘ NA = NA).

pub fn take(&self, idx: &[usize]) -> Validity

Gather present-flags at idx (fancy indexing / dropna). Dense stays dense.

pub fn slice(&self, start: usize, end: usize) -> Validity

Present-flags over [start, end) (slicing). Dense stays dense.

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 Default for Validity

fn default() -> Validity

Returns the “default value” for a type.

impl PartialEq for Validity

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

Dense compares equal to an all-present bitmap (the constructors keep Some non-trivial, so in practice this reduces to comparing patterns).

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

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