Enum Validity

pub enum Validity {
    NonNullable,
    AllValid,
    AllInvalid,
    Array(ArrayData),
}

Validity information for an array

Variants

NonNullable

Items can’t be null

AllValid

All items are valid

AllInvalid

All items are null

Array(ArrayData)

Specified items are null

Implementations

impl Validity

pub const DTYPE: DType

The DType of the underlying validity array (if it exists).

pub fn to_metadata(&self, length: usize) -> VortexResult<ValidityMetadata>

pub fn null_count(&self, length: usize) -> VortexResult<usize>

pub fn into_array(self) -> Option<ArrayData>

If Validity is Validity::Array, returns the array, otherwise returns None.

pub fn as_array(&self) -> Option<&ArrayData>

If Validity is Validity::Array, returns a reference to the array array, otherwise returns None.

pub fn nullability(&self) -> Nullability

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

Returns whether the index item is valid.

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

pub fn slice(&self, start: usize, stop: usize) -> VortexResult<Self>

pub fn take(&self, indices: &ArrayData) -> VortexResult<Self>

pub unsafe fn take_unchecked(&self, indices: &ArrayData) -> VortexResult<Self>

Take the validity buffer at the provided indices.

Safety

It is assumed the caller has checked that all indices are <= the length of this validity buffer.

Failure to do so may result in UB.

pub fn filter(&self, mask: &FilterMask) -> VortexResult<Self>

pub fn to_logical(&self, length: usize) -> LogicalValidity

pub fn and(self, rhs: Validity) -> VortexResult<Validity>

Logically & two Validity values of the same length

pub fn patch( self, len: usize, indices: &ArrayData, patches: Validity, ) -> VortexResult<Self>

pub fn into_nullable(self) -> Validity

Convert into a nullable variant

pub fn from_array( value: ArrayData, nullability: Nullability, ) -> VortexResult<Self>

Create Validity from boolean array with given nullability of the array.

Note: You want to pass the nullability of parent array and not the nullability of the validity array itself as that is always nonnullable

Trait Implementations

impl Clone for Validity

fn clone(&self) -> Validity

Returns a copy 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 From<BooleanBuffer> for Validity

fn from(value: BooleanBuffer) -> Self

Converts to this type from the input type.

impl From<NullBuffer> for Validity

fn from(value: NullBuffer) -> Self

Converts to this type from the input type.

impl From<Nullability> for Validity

fn from(value: Nullability) -> Self

Converts to this type from the input type.

impl FromIterator<LogicalValidity> for Validity

fn from_iter<T: IntoIterator<Item = LogicalValidity>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<bool> for Validity

fn from_iter<T: IntoIterator<Item = bool>>(iter: T) -> Self

Creates a value from an iterator.

impl PartialEq for Validity

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.