Enum Validity

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

Validity information for an array

Variants

NonNullable

Items can’t be null

AllValid

All items are valid

AllInvalid

All items are null

Array(ArrayRef)

Specified items are null

Implementations

impl Validity

pub const DTYPE: DType

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

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

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

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

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

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

pub fn nullability(&self) -> Nullability

pub fn union_nullability(self, nullability: Nullability) -> Self

The union nullability and validity.

pub fn all_valid(&self) -> VortexResult<bool>

pub fn all_invalid(&self) -> VortexResult<bool>

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

Returns whether the index item is valid.

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

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

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

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

Keep only the entries for which the mask is true.

The result has length equal to the number of true values in mask.

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

Set to false any entries for which the mask is true.

The result is always nullable. The result has the same length as self.

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

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

Logically & two Validity values of the same length

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

pub fn into_nullable(self) -> Validity

Convert into a nullable variant

pub fn into_non_nullable(self) -> Option<Validity>

Convert into a non-nullable variant

pub fn cast_nullability( self, nullability: Nullability, ) -> VortexResult<Validity>

Convert into a variant compatible with the given nullability, if possible.

pub fn copy_from_array(array: &dyn Array) -> VortexResult<Self>

Create Validity by copying the given array’s validity.

pub fn maybe_len(&self) -> Option<usize>

Returns the length of the validity array, if it exists.

pub fn uncompressed_size(&self) -> usize

pub fn is_array(&self) -> bool

impl Validity

pub fn from_mask(mask: Mask, nullability: Nullability) -> Self

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

fn from_iter<T: IntoIterator<Item = Mask>>(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.