Struct narrow::array::VariableSizeListArray

pub struct VariableSizeListArray<T: Array, const NULLABLE: bool = false, OffsetItem: OffsetElement = i32, Buffer: BufferType = VecBuffer>(pub Offset<T, NULLABLE, OffsetItem, Buffer>)
where
    <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>;

Array with variable-size list elements.

Tuple Fields

0: Offset<T, NULLABLE, OffsetItem, Buffer>

Trait Implementations

impl<T: Array, const NULLABLE: bool, OffsetItem: OffsetElement, Buffer: BufferType> Array for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>

where <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>, Vec<T>: Nullability<NULLABLE>,

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

The items stored in this array.

impl<T: Array, const NULLABLE: bool, OffsetItem: OffsetElement + OffsetSizeTrait, Buffer: BufferType> Array for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>

where <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>, Vec<T>: Nullability<NULLABLE>,

Available on crate feature arrow-rs only.

type Array = GenericListArray<OffsetItem>

The corresponding arrow array

fn as_field(name: &str) -> Field

Returns the field of this array.

impl<T: Array, OffsetItem: OffsetElement, Buffer: BufferType> BitmapRef for VariableSizeListArray<T, true, OffsetItem, 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: Array, OffsetItem: OffsetElement, Buffer: BufferType> BitmapRefMut for VariableSizeListArray<T, true, OffsetItem, Buffer>

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

Returns a mutable reference to a Bitmap.

impl<T: Array, const NULLABLE: bool, OffsetItem: OffsetElement, Buffer: BufferType> Debug for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>

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

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

Formats the value using the given formatter.

impl<T: Array, const NULLABLE: bool, OffsetItem: OffsetElement, Buffer: BufferType> Default for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>

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

fn default() -> Self

Returns the “default value” for a type.

impl<T: Array, U, const NULLABLE: bool, OffsetItem: OffsetElement, Buffer: BufferType> Extend<U> for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>

where <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>, Offset<T, NULLABLE, OffsetItem, 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: Array, const NULLABLE: bool, OffsetItem: OffsetElement + OffsetSizeTrait, Buffer: BufferType> From<Arc<dyn Array>> for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>

where <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>, Self: From<GenericListArray<OffsetItem>>,

Available on crate feature arrow-rs only.

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

Converts to this type from the input type.

impl<T, OffsetItem: OffsetElement + OffsetSizeTrait, Buffer: BufferType> From<GenericListArray<OffsetItem>> for VariableSizeListArray<T, false, OffsetItem, Buffer>

where T: From<Arc<dyn Array>> + Array, <Buffer as BufferType>::Buffer<OffsetItem>: From<ScalarBuffer<OffsetItem>>,

Available on crate feature arrow-rs only.

Panics when there are nulls

fn from(value: GenericListArray<OffsetItem>) -> Self

Converts to this type from the input type.

impl<T, OffsetItem: OffsetElement + OffsetSizeTrait, Buffer: BufferType> From<GenericListArray<OffsetItem>> for VariableSizeListArray<T, true, OffsetItem, Buffer>

where T: From<Arc<dyn Array>> + Array, <Buffer as BufferType>::Buffer<OffsetItem>: From<ScalarBuffer<OffsetItem>>, Bitmap<Buffer>: From<NullBuffer>,

Available on crate feature arrow-rs only.

Panics when there are no nulls

fn from(value: GenericListArray<OffsetItem>) -> Self

Converts to this type from the input type.

impl<const NULLABLE: bool, OffsetItem: OffsetElement, Buffer: BufferType> From<VariableSizeListArray<FixedSizePrimitiveArray<u8, false, Buffer>, NULLABLE, OffsetItem, Buffer>> for VariableSizeBinaryArray<NULLABLE, OffsetItem, Buffer>

where <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>,

fn from( value: VariableSizeListArray<FixedSizePrimitiveArray<u8, false, Buffer>, NULLABLE, OffsetItem, Buffer>, ) -> Self

Converts to this type from the input type.

impl<T: Array + Array, OffsetItem: OffsetElement + OffsetSizeTrait, Buffer: BufferType> From<VariableSizeListArray<T, false, OffsetItem, Buffer>> for Arc<dyn Array>

where <Buffer as BufferType>::Buffer<OffsetItem>: Into<ScalarBuffer<OffsetItem>>, <T as Array>::Array: From<T> + 'static,

Available on crate feature arrow-rs only.

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

Converts to this type from the input type.

impl<T: Array + Array, OffsetItem: OffsetElement + OffsetSizeTrait, Buffer: BufferType> From<VariableSizeListArray<T, false, OffsetItem, Buffer>> for GenericListArray<OffsetItem>

where <Buffer as BufferType>::Buffer<OffsetItem>: Into<ScalarBuffer<OffsetItem>>, <T as Array>::Array: From<T> + 'static,

Available on crate feature arrow-rs only.

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

Converts to this type from the input type.

impl<T: Array, OffsetItem: OffsetElement, Buffer: BufferType> From<VariableSizeListArray<T, false, OffsetItem, Buffer>> for VariableSizeListArray<T, true, OffsetItem, Buffer>

where Offset<T, false, OffsetItem, Buffer>: Into<Offset<T, true, OffsetItem, Buffer>>,

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

Converts to this type from the input type.

impl<T: Array + Array, OffsetItem: OffsetElement + OffsetSizeTrait, Buffer: BufferType> From<VariableSizeListArray<T, true, OffsetItem, Buffer>> for Arc<dyn Array>

where <Buffer as BufferType>::Buffer<OffsetItem>: Into<ScalarBuffer<OffsetItem>>, Bitmap<Buffer>: Into<NullBuffer>, <T as Array>::Array: From<T> + 'static,

Available on crate feature arrow-rs only.

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

Converts to this type from the input type.

impl<T: Array + Array, OffsetItem: OffsetElement + OffsetSizeTrait, Buffer: BufferType> From<VariableSizeListArray<T, true, OffsetItem, Buffer>> for GenericListArray<OffsetItem>

where <Buffer as BufferType>::Buffer<OffsetItem>: Into<ScalarBuffer<OffsetItem>>, Bitmap<Buffer>: Into<NullBuffer>, <T as Array>::Array: From<T> + 'static,

Available on crate feature arrow-rs only.

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

Converts to this type from the input type.

impl<T: Array, U, const NULLABLE: bool, OffsetItem: OffsetElement, Buffer: BufferType> FromIterator<U> for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>

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

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

Creates a value from an iterator.

impl<T: Array, const NULLABLE: bool, OffsetItem: OffsetElement, Buffer: BufferType> Index for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>

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

type Item<'a> = <Offset<T, NULLABLE, OffsetItem, 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: Array, const NULLABLE: bool, OffsetItem: OffsetElement, Buffer: BufferType> Length for VariableSizeListArray<T, NULLABLE, OffsetItem, Buffer>

where <Buffer as BufferType>::Buffer<OffsetItem>: Validity<NULLABLE>, Offset<T, NULLABLE, OffsetItem, 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: Array, OffsetItem: OffsetElement, Buffer: BufferType> ValidityBitmap for VariableSizeListArray<T, true, OffsetItem, 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.