Struct narrow::array::FixedSizePrimitiveArray

pub struct FixedSizePrimitiveArray<T: FixedSize, const NULLABLE: bool = false, Buffer: BufferType = VecBuffer>(pub <<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<Buffer>)
where
    <Buffer as BufferType>::Buffer<T>: Validity<NULLABLE>;

Array with primitive values.

Tuple Fields

0: <<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<Buffer>

Implementations

impl<T: FixedSize, const NULLABLE: bool, Buffer: BufferType> FixedSizePrimitiveArray<T, NULLABLE, Buffer>

where <Buffer as BufferType>::Buffer<T>: Validity<NULLABLE>, for<'a> &'a <<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<Buffer>: IntoIterator,

pub fn iter( &self, ) -> <&<<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<Buffer> as IntoIterator>::IntoIter

Returns an iterator over the items in this FixedSizePrimitiveArray.

Trait Implementations

impl<T, const NULLABLE: bool, Buffer: BufferType> Array for FixedSizePrimitiveArray<T, NULLABLE, Buffer>

where <Buffer as BufferType>::Buffer<T>: Validity<NULLABLE>, T: Nullability<NULLABLE> + FixedSize,

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

The items stored in this array.

impl<const NULLABLE: bool, T, Buffer: BufferType> Array for FixedSizePrimitiveArray<T, NULLABLE, Buffer>

where <Buffer as BufferType>::Buffer<T>: Validity<NULLABLE>, T: Nullability<NULLABLE> + FixedSize + FixedSizeExt,

Available on crate feature arrow-rs only.

type Array = PrimitiveArray<<T as FixedSizeExt>::ArrowPrimitiveType>

The corresponding arrow array

fn as_field(name: &str) -> Field

Returns the field of this array.

impl<T: FixedSize, Buffer: BufferType> AsRef<[T]> for FixedSizePrimitiveArray<T, false, Buffer>

fn as_ref(&self) -> &[T]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: FixedSize, Buffer: BufferType> BitmapRef for FixedSizePrimitiveArray<T, true, 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: FixedSize, Buffer: BufferType> BitmapRefMut for FixedSizePrimitiveArray<T, true, Buffer>

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

Returns a mutable reference to a Bitmap.

impl<T: FixedSize, const NULLABLE: bool, Buffer: BufferType> Clone for FixedSizePrimitiveArray<T, NULLABLE, Buffer>

where <Buffer as BufferType>::Buffer<T>: Validity<NULLABLE>, <<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<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: FixedSize, const NULLABLE: bool, Buffer: BufferType> Debug for FixedSizePrimitiveArray<T, NULLABLE, Buffer>

where <Buffer as BufferType>::Buffer<T>: Validity<NULLABLE>, <<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<Buffer>: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: FixedSize, const NULLABLE: bool, Buffer: BufferType> Default for FixedSizePrimitiveArray<T, NULLABLE, Buffer>

where <Buffer as BufferType>::Buffer<T>: Validity<NULLABLE>, <<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<Buffer>: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T: FixedSize, U, const NULLABLE: bool, Buffer: BufferType> Extend<U> for FixedSizePrimitiveArray<T, NULLABLE, Buffer>

where <Buffer as BufferType>::Buffer<T>: Validity<NULLABLE>, <<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<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<const NULLABLE: bool, T: FixedSizeExt, Buffer: BufferType> From<Arc<dyn Array>> for FixedSizePrimitiveArray<T, NULLABLE, Buffer>

where <Buffer as BufferType>::Buffer<T>: Validity<NULLABLE>, Self: From<PrimitiveArray<<T as FixedSizeExt>::ArrowPrimitiveType>>,

Available on crate feature arrow-rs only.

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

Converts to this type from the input type.

impl<T: FixedSizeExt, const NULLABLE: bool, Buffer: BufferType> From<FixedSizePrimitiveArray<T, NULLABLE, Buffer>> for Arc<dyn Array>

where <Buffer as BufferType>::Buffer<T>: Validity<NULLABLE>, PrimitiveArray<<T as FixedSizeExt>::ArrowPrimitiveType>: From<FixedSizePrimitiveArray<T, NULLABLE, Buffer>>,

Available on crate feature arrow-rs only.

fn from(value: FixedSizePrimitiveArray<T, NULLABLE, Buffer>) -> Self

Converts to this type from the input type.

impl<T: FixedSize, Buffer: BufferType> From<FixedSizePrimitiveArray<T, false, Buffer>> for FixedSizePrimitiveArray<T, true, Buffer>

where <Buffer as BufferType>::Buffer<T>: Length, Bitmap<Buffer>: FromIterator<bool>,

fn from(value: FixedSizePrimitiveArray<T, false, Buffer>) -> Self

Converts to this type from the input type.

impl<T: FixedSize, U: ArrowPrimitiveType<Native = T>, Buffer: BufferType> From<FixedSizePrimitiveArray<T, false, Buffer>> for PrimitiveArray<U>

where ScalarBuffer<T>: From<<Buffer as BufferType>::Buffer<T>>,

Available on crate feature arrow-rs only.

fn from(value: FixedSizePrimitiveArray<T, false, Buffer>) -> Self

Converts to this type from the input type.

impl<T: FixedSize, Buffer: BufferType> From<FixedSizePrimitiveArray<T, false, Buffer>> for ScalarBuffer<T>

where <Buffer as BufferType>::Buffer<T>: Into<ScalarBuffer<T>>,

Available on crate feature arrow-rs only.

fn from(value: FixedSizePrimitiveArray<T, false, Buffer>) -> Self

Converts to this type from the input type.

impl<T: FixedSize, U: ArrowPrimitiveType<Native = T>, Buffer: BufferType> From<FixedSizePrimitiveArray<T, true, Buffer>> for PrimitiveArray<U>

where ScalarBuffer<T>: From<<Buffer as BufferType>::Buffer<T>>, NullBuffer: From<Bitmap<Buffer>>,

Available on crate feature arrow-rs only.

fn from(value: FixedSizePrimitiveArray<T, true, Buffer>) -> Self

Converts to this type from the input type.

impl<T: FixedSize, U: ArrowPrimitiveType<Native = T>, Buffer: BufferType> From<PrimitiveArray<U>> for FixedSizePrimitiveArray<T, false, Buffer>

where <Buffer as BufferType>::Buffer<T>: From<ScalarBuffer<T>>,

Available on crate feature arrow-rs only.

Panics when there are nulls.

fn from(value: PrimitiveArray<U>) -> Self

Converts to this type from the input type.

impl<T: FixedSize, U: ArrowPrimitiveType<Native = T>, Buffer: BufferType> From<PrimitiveArray<U>> for FixedSizePrimitiveArray<T, true, Buffer>

where <Buffer as BufferType>::Buffer<T>: From<ScalarBuffer<T>>, Bitmap<Buffer>: From<NullBuffer> + FromIterator<bool>,

Available on crate feature arrow-rs only.

fn from(value: PrimitiveArray<U>) -> Self

Converts to this type from the input type.

impl<T: FixedSize, Buffer: BufferType> From<ScalarBuffer<T>> for FixedSizePrimitiveArray<T, false, Buffer>

where <Buffer as BufferType>::Buffer<T>: From<ScalarBuffer<T>>,

Available on crate feature arrow-rs only.

fn from(value: ScalarBuffer<T>) -> Self

Converts to this type from the input type.

impl<T: FixedSize, const NULLABLE: bool, U, Buffer: BufferType> FromIterator<U> for FixedSizePrimitiveArray<T, NULLABLE, Buffer>

where <Buffer as BufferType>::Buffer<T>: Validity<NULLABLE>, <<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<Buffer>: FromIterator<U>,

fn from_iter<I: IntoIterator<Item = U>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: FixedSize, I: SliceIndex<[T]>, Buffer: BufferType> Index<I> for FixedSizePrimitiveArray<T, false, Buffer>

where <Buffer as BufferType>::Buffer<T>: Index<I, Output = <I as SliceIndex<[T]>>::Output>,

type Output = <I as SliceIndex<[T]>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T: FixedSize, Buffer: BufferType, const NULLABLE: bool> Index for FixedSizePrimitiveArray<T, NULLABLE, Buffer>

where <Buffer as BufferType>::Buffer<T>: Validity<NULLABLE>, <<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<Buffer>: Index,

type Item<'a> = <<<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<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<'a, T: FixedSize, const NULLABLE: bool, Buffer: BufferType> IntoIterator for &'a FixedSizePrimitiveArray<T, NULLABLE, Buffer>

where <Buffer as BufferType>::Buffer<T>: Validity<NULLABLE>, &'a <<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<Buffer>: IntoIterator,

type Item = <&'a <<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<Buffer> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <&'a <<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<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: FixedSize, const NULLABLE: bool, Buffer: BufferType> IntoIterator for FixedSizePrimitiveArray<T, NULLABLE, Buffer>

where <Buffer as BufferType>::Buffer<T>: Validity<NULLABLE>, <<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<Buffer>: IntoIterator,

type Item = <<<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<Buffer> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <<<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<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: FixedSize, const NULLABLE: bool, Buffer: BufferType> Length for FixedSizePrimitiveArray<T, NULLABLE, Buffer>

where <Buffer as BufferType>::Buffer<T>: Validity<NULLABLE>, <<Buffer as BufferType>::Buffer<T> as Validity<NULLABLE>>::Storage<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: FixedSize, Buffer: BufferType> PartialEq<[Option<T>]> for FixedSizePrimitiveArray<T, true, Buffer>

where for<'a> &'a Self: IntoIterator<Item = Option<T>>,

fn eq(&self, other: &[Option<T>]) -> 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.

impl<T: FixedSize, Buffer: BufferType> PartialEq<[T]> for FixedSizePrimitiveArray<T, false, Buffer>

where <Buffer as BufferType>::Buffer<T>: PartialEq<[T]>,

fn eq(&self, other: &[T]) -> 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.

impl<T: FixedSize, U: ArrowPrimitiveType<Native = T>, Buffer: BufferType> PartialEq<PrimitiveArray<U>> for FixedSizePrimitiveArray<T, false, Buffer>

Available on crate feature arrow-rs only.

fn eq(&self, other: &PrimitiveArray<U>) -> 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.

impl<T: FixedSize, U: ArrowPrimitiveType<Native = T>, Buffer: BufferType> PartialEq<PrimitiveArray<U>> for FixedSizePrimitiveArray<T, true, Buffer>

where for<'a> &'a Self: IntoIterator<Item = Option<&'a T>>,

Available on crate feature arrow-rs only.

fn eq(&self, other: &PrimitiveArray<U>) -> 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.

impl<T: FixedSize, Buffer: BufferType> PartialEq for FixedSizePrimitiveArray<T, false, Buffer>

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.

impl<T: FixedSize, Buffer: BufferType> ValidityBitmap for FixedSizePrimitiveArray<T, true, 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.