Struct NullArray

pub struct NullArray<T: Unit = (), Nullable: Nullability = NonNullable, Buffer: BufferType = VecBuffer>(/* private fields */);

A sequence of nulls.

Trait Implementations

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

type Item = <Nullable as Nullability>::Item<T>

The items stored in this array.

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

Available on crate feature arrow-rs only.

type Array = NullArray

The corresponding arrow array

fn as_field(name: &str) -> Field

Returns the field of this array.

fn data_type() -> DataType

Returns the data type of this array.

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

type Buffer = Buffer

The buffer type of the bitmap.

fn bitmap_ref(&self) -> &Bitmap<Self::Buffer>

Returns a reference to an immutable Bitmap.

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

fn bitmap_ref_mut(&mut self) -> &mut Bitmap<Self::Buffer>

Returns a mutable reference to a Bitmap.

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

where Nullable::Collection<Nulls<T>, Buffer>: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

where Nullable::Collection<Nulls<T>, Buffer>: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T: Unit, U, Nullable: Nullability, Buffer: BufferType> Extend<U> for NullArray<T, Nullable, Buffer>

where Nullable::Collection<Nulls<T>, Buffer>: Extend<U>,

fn extend<I: IntoIterator<Item = U>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T: Unit, Buffer: BufferType> From<Arc<dyn Array>> for NullArray<T, NonNullable, Buffer>

where Self: From<NullArray>,

Available on crate feature arrow-rs only.

fn from(value: Arc<dyn Array>) -> Self

Converts to this type from the input type.

impl<T: Unit, Buffer: BufferType> From<NullArray<T, NonNullable, Buffer>> for Arc<dyn Array>

where NullArray: From<NullArray<T, NonNullable, Buffer>>,

Available on crate feature arrow-rs only.

fn from(value: NullArray<T, NonNullable, Buffer>) -> Self

Converts to this type from the input type.

impl<T: Unit, Buffer: BufferType> From<NullArray<T, NonNullable, Buffer>> for NullArray

Available on crate feature arrow-rs only.

fn from(value: NullArray<T, NonNullable, Buffer>) -> Self

Converts to this type from the input type.

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

where Bitmap<Buffer>: FromIterator<bool>,

fn from(value: NullArray<T, NonNullable, Buffer>) -> Self

Converts to this type from the input type.

impl<T: Unit, Buffer: BufferType> From<NullArray> for NullArray<T, NonNullable, Buffer>

Available on crate feature arrow-rs only.

fn from(value: NullArray) -> Self

Converts to this type from the input type.

impl<T: Unit, U, Nullable: Nullability, Buffer: BufferType> FromIterator<U> for NullArray<T, Nullable, Buffer>

where Nullable::Collection<Nulls<T>, Buffer>: FromIterator<U>,

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = U>,

Creates a value from an iterator.

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

where Nullable::Collection<Nulls<T>, Buffer>: Index,

type Item<'a> = <<Nullable as Nullability>::Collection<Nulls<T>, Buffer> as Index>::Item<'a> where Self: 'a

The item.

unsafe fn index_unchecked(&self, index: usize) -> Self::Item<'_>

Returns the value at given index. Skips bound checking.

fn index(&self, index: usize) -> Option<Self::Item<'_>>

Returns the value at given index. Returns None if the index is out of range.

fn index_checked(&self, index: usize) -> Self::Item<'_>

Returns the value at given index. Panics if the index is out of bounds.

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

where Nullable::Collection<Nulls<T>, Buffer>: IntoIterator,

type Item = <<Nullable as Nullability>::Collection<Nulls<T>, Buffer> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <<Nullable as Nullability>::Collection<Nulls<T>, Buffer> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

where Nullable::Collection<Nulls<T>, Buffer>: Length,

fn len(&self) -> usize

Returns the number of elements in the collection, also referred to as its length.

fn is_empty(&self) -> bool

Returns true if there are no elements in the collection.

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

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

Returns true if the element at position index is null.

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

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

fn null_count(&self) -> usize

Returns the number of null elements.

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

Returns true if the element at position index is valid.

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

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

fn valid_count(&self) -> usize

Returns the number of valid elements.

fn any_null(&self) -> bool

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

fn all_null(&self) -> bool

Returns true if all the elements are null.

fn any_valid(&self) -> bool

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

fn all_valid(&self) -> bool

Returns true if all the elements are valid.