Trait ValidityBitmap

Source
pub trait ValidityBitmap: BitmapRef {
    // Provided methods
    fn is_null(&self, index: usize) -> Option<bool> { ... }
    unsafe fn is_null_unchecked(&self, index: usize) -> bool { ... }
    fn null_count(&self) -> usize { ... }
    fn is_valid(&self, index: usize) -> Option<bool> { ... }
    unsafe fn is_valid_unchecked(&self, index: usize) -> bool { ... }
    fn valid_count(&self) -> usize { ... }
    fn any_null(&self) -> bool { ... }
    fn all_null(&self) -> bool { ... }
    fn any_valid(&self) -> bool { ... }
    fn all_valid(&self) -> bool { ... }
}
Expand description

A validity bitmap storing the validity information (null-ness) of elements in a collection in a bitmap.

Provided Methods§

Source

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

Returns true if the element at position index is null.

Source

unsafe fn is_null_unchecked(&self, index: usize) -> bool

Returns true if the element at position index is null, without performing any bounds checking.

§Safety
  • The index must be in bounds.

Calling this method with an out-of-bounds index is undefined behavior.

Source

fn null_count(&self) -> usize

Returns the number of null elements.

Source

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

Returns true if the element at position index is valid.

Source

unsafe fn is_valid_unchecked(&self, index: usize) -> bool

Returns true if the element at position index is valid, without performing any bounds checking.

§Safety
  • The index must be in bounds.

Calling this method with an out-of-bounds index is undefined behavior.

Source

fn valid_count(&self) -> usize

Returns the number of valid elements.

Source

fn any_null(&self) -> bool

Returns true if the array contains at least one null element.

Source

fn all_null(&self) -> bool

Returns true if all the elements are null.

Source

fn any_valid(&self) -> bool

Returns true if the array contains at least one valid element.

Source

fn all_valid(&self) -> bool

Returns true if all the elements are valid.

Implementors§

Source§

impl<Buffer: BufferType> ValidityBitmap for BooleanArray<Nullable, Buffer>

Source§

impl<Buffer: BufferType> ValidityBitmap for Bitmap<Buffer>

Source§

impl<OffsetItem: Offset, Buffer: BufferType> ValidityBitmap for StringArray<Nullable, OffsetItem, Buffer>

Source§

impl<OffsetItem: Offset, Buffer: BufferType> ValidityBitmap for VariableSizeBinaryArray<Nullable, OffsetItem, Buffer>

Source§

impl<T, OffsetItem: Offset, Buffer: BufferType> ValidityBitmap for Offsets<T, Nullable, OffsetItem, Buffer>

Source§

impl<T: Array, OffsetItem: Offset, Buffer: BufferType> ValidityBitmap for VariableSizeListArray<T, Nullable, OffsetItem, Buffer>

Source§

impl<T: StructArrayType, Buffer: BufferType> ValidityBitmap for StructArray<T, Nullable, Buffer>

Source§

impl<T: Unit, Buffer: BufferType> ValidityBitmap for NullArray<T, Nullable, Buffer>

Source§

impl<T: FixedSize, Buffer: BufferType> ValidityBitmap for FixedSizePrimitiveArray<T, Nullable, Buffer>

Source§

impl<const N: usize, Buffer: BufferType> ValidityBitmap for FixedSizeBinaryArray<N, Nullable, Buffer>

Source§

impl<const N: usize, T: Array, Buffer: BufferType> ValidityBitmap for FixedSizeListArray<N, T, Nullable, Buffer>