Struct narrow::array::FixedSizeBinaryArray

pub struct FixedSizeBinaryArray<const N: usize, const NULLABLE: bool = false, Buffer: BufferType = VecBuffer>(/* private fields */)
where
    FixedSizePrimitiveArray<u8, false, Buffer>: Validity<NULLABLE>;

Array with fixed-size binary elements.

Implementations

impl<const N: usize, const NULLABLE: bool, Buffer: BufferType> FixedSizeBinaryArray<N, NULLABLE, Buffer>

where FixedSizePrimitiveArray<u8, false, Buffer>: Validity<NULLABLE>, FixedSizeBinaryArray<N, NULLABLE, Buffer>: Index + Length,

pub fn iter(&self) -> FixedSizeBinaryIter<'_, N, NULLABLE, Buffer>

Returns an iterator over items in this FixedSizeListArray.

Trait Implementations

impl<const N: usize, const NULLABLE: bool, Buffer: BufferType> Array for FixedSizeBinaryArray<N, NULLABLE, Buffer>

where FixedSizePrimitiveArray<u8, false, Buffer>: Validity<NULLABLE>, [u8; N]: Nullability<NULLABLE>,

type Item = <[u8; N] as Nullability<NULLABLE>>::Item

The items stored in this array.

impl<const N: usize, const NULLABLE: bool, Buffer: BufferType> Array for FixedSizeBinaryArray<N, NULLABLE, Buffer>

where FixedSizePrimitiveArray<u8, false, Buffer>: Validity<NULLABLE>, [u8; N]: Nullability<NULLABLE>,

Available on crate feature arrow-rs only.

type Array = FixedSizeBinaryArray

The corresponding arrow array

fn as_field(name: &str) -> Field

Returns the field of this array.

impl<const N: usize, Buffer: BufferType> BitmapRef for FixedSizeBinaryArray<N, 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<const N: usize, Buffer: BufferType> BitmapRefMut for FixedSizeBinaryArray<N, true, Buffer>

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

Returns a mutable reference to a Bitmap.

impl<const N: usize, const NULLABLE: bool, Buffer: BufferType> Default for FixedSizeBinaryArray<N, NULLABLE, Buffer>

where FixedSizePrimitiveArray<u8, false, Buffer>: Validity<NULLABLE>, FixedSizeListArray<N, FixedSizePrimitiveArray<u8, false, Buffer>, NULLABLE, Buffer>: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T, const N: usize, Buffer: BufferType> Extend<Option<T>> for FixedSizeBinaryArray<N, true, Buffer>

where T: Into<[u8; N]>, FixedSizeListArray<N, FixedSizePrimitiveArray<u8, false, Buffer>, true, Buffer>: Extend<Option<[u8; N]>>,

fn extend<I: IntoIterator<Item = Option<T>>>(&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, const N: usize, Buffer: BufferType> Extend<T> for FixedSizeBinaryArray<N, false, Buffer>

where T: Into<[u8; N]>, FixedSizeListArray<N, FixedSizePrimitiveArray<u8, false, Buffer>, false, Buffer>: Extend<[u8; N]>,

fn extend<I: IntoIterator<Item = T>>(&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 N: usize, const NULLABLE: bool, Buffer: BufferType> From<Arc<dyn Array>> for FixedSizeBinaryArray<N, NULLABLE, Buffer>

where FixedSizePrimitiveArray<u8, false, Buffer>: Validity<NULLABLE>, Self: From<FixedSizeBinaryArray>,

Available on crate feature arrow-rs only.

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

Converts to this type from the input type.

impl<const NULLABLE: bool, const N: usize, Buffer: BufferType> From<FixedSizeBinaryArray<N, NULLABLE, Buffer>> for Arc<dyn Array>

where FixedSizePrimitiveArray<u8, false, Buffer>: Validity<NULLABLE>, FixedSizeBinaryArray: From<FixedSizeBinaryArray<N, NULLABLE, Buffer>>,

Available on crate feature arrow-rs only.

fn from(value: FixedSizeBinaryArray<N, NULLABLE, Buffer>) -> Self

Converts to this type from the input type.

impl<const N: usize, Buffer: BufferType> From<FixedSizeBinaryArray<N, false, Buffer>> for FixedSizeBinaryArray

where PrimitiveArray<UInt8Type>: From<FixedSizePrimitiveArray<u8, false, Buffer>>,

Available on crate feature arrow-rs only.

fn from(value: FixedSizeBinaryArray<N, false, Buffer>) -> Self

Converts to this type from the input type.

impl<const N: usize, Buffer: BufferType> From<FixedSizeBinaryArray<N, false, Buffer>> for FixedSizeBinaryArray<N, true, Buffer>

where FixedSizeListArray<N, FixedSizePrimitiveArray<u8, false, Buffer>, true, Buffer>: From<FixedSizeListArray<N, FixedSizePrimitiveArray<u8, false, Buffer>, false, Buffer>>,

fn from(value: FixedSizeBinaryArray<N, false, Buffer>) -> Self

Converts to this type from the input type.

impl<const N: usize, Buffer: BufferType> From<FixedSizeBinaryArray<N, true, Buffer>> for FixedSizeBinaryArray

where PrimitiveArray<UInt8Type>: From<FixedSizePrimitiveArray<u8, false, Buffer>>, Bitmap<Buffer>: Into<NullBuffer>,

Available on crate feature arrow-rs only.

fn from(value: FixedSizeBinaryArray<N, true, Buffer>) -> Self

Converts to this type from the input type.

impl<const N: usize, Buffer: BufferType> From<FixedSizeBinaryArray> for FixedSizeBinaryArray<N, false, Buffer>

where FixedSizePrimitiveArray<u8, false, Buffer>: From<ScalarBuffer<u8>>,

Available on crate feature arrow-rs only.

Panics when there are nulls

fn from(value: FixedSizeBinaryArray) -> Self

Converts to this type from the input type.

impl<const N: usize, Buffer: BufferType> From<FixedSizeBinaryArray> for FixedSizeBinaryArray<N, true, Buffer>

where FixedSizePrimitiveArray<u8, false, Buffer>: From<ScalarBuffer<u8>>, Bitmap<Buffer>: From<NullBuffer> + FromIterator<bool>,

Available on crate feature arrow-rs only.

fn from(value: FixedSizeBinaryArray) -> Self

Converts to this type from the input type.

impl<T, const N: usize, Buffer: BufferType> FromIterator<Option<T>> for FixedSizeBinaryArray<N, true, Buffer>

where T: Into<[u8; N]>, FixedSizeListArray<N, FixedSizePrimitiveArray<u8, false, Buffer>, true, Buffer>: FromIterator<Option<[u8; N]>>,

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

Creates a value from an iterator.

impl<T, const N: usize, Buffer: BufferType> FromIterator<T> for FixedSizeBinaryArray<N, false, Buffer>

where T: Into<[u8; N]>, FixedSizeListArray<N, FixedSizePrimitiveArray<u8, false, Buffer>, false, Buffer>: FromIterator<[u8; N]>,

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

Creates a value from an iterator.

impl<const N: usize, const NULLABLE: bool, Buffer: BufferType> Index for FixedSizeBinaryArray<N, NULLABLE, Buffer>

where FixedSizePrimitiveArray<u8, false, Buffer>: Validity<NULLABLE>, FixedSizeListArray<N, FixedSizePrimitiveArray<u8, false, Buffer>, NULLABLE, Buffer>: Index,

type Item<'a> = <FixedSizeListArray<N, FixedSizePrimitiveArray<u8, false, Buffer>, NULLABLE, 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, const N: usize, const NULLABLE: bool, Buffer: BufferType> IntoIterator for &'a FixedSizeBinaryArray<N, NULLABLE, Buffer>

where FixedSizePrimitiveArray<u8, false, Buffer>: Validity<NULLABLE>, FixedSizeBinaryArray<N, NULLABLE, Buffer>: Index + Length,

type Item = <FixedSizeBinaryArray<N, NULLABLE, Buffer> as Index>::Item<'a>

The type of the elements being iterated over.

type IntoIter = FixedSizeBinaryIter<'a, N, NULLABLE, Buffer>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const N: usize, const NULLABLE: bool, Buffer: BufferType> IntoIterator for FixedSizeBinaryArray<N, NULLABLE, Buffer>

where FixedSizePrimitiveArray<u8, false, Buffer>: Validity<NULLABLE>, FixedSizeBinaryIntoIter<N, NULLABLE, Buffer>: Iterator,

type Item = <FixedSizeBinaryIntoIter<N, NULLABLE, Buffer> as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = FixedSizeBinaryIntoIter<N, NULLABLE, Buffer>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const N: usize, const NULLABLE: bool, Buffer: BufferType> Length for FixedSizeBinaryArray<N, NULLABLE, Buffer>

where FixedSizePrimitiveArray<u8, false, Buffer>: Validity<NULLABLE>, FixedSizeListArray<N, FixedSizePrimitiveArray<u8, false, Buffer>, NULLABLE, 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<const N: usize, Buffer: BufferType> ValidityBitmap for FixedSizeBinaryArray<N, 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.