Struct ListArray

pub struct ListArray<O: Offset> { /* private fields */ }

An Array semantically equivalent to Vec<Option<Vec<Option<T>>>> with Arrow’s in-memory.

Implementations

impl<'a, O: Offset> ListArray<O>

pub fn iter( &'a self, ) -> ZipValidity<Box<dyn Array>, ListValuesIter<'a, O>, BitmapIter<'a>>

Returns an iterator of Option<Box<dyn Array>>

pub fn values_iter(&'a self) -> ListValuesIter<'a, O>

Returns an iterator of Box<dyn Array>

pub fn non_null_values_iter(&'a self) -> NonNullValuesIter<'a, ListArray<O>>

Returns an iterator of the non-null values Box<dyn Array>.

impl<O: Offset> ListArray<O>

pub fn try_new( dtype: ArrowDataType, offsets: OffsetsBuffer<O>, values: Box<dyn Array>, validity: Option<Bitmap>, ) -> PolarsResult<Self>

Creates a new ListArray.

Errors

This function returns an error iff:

• The last offset is not equal to the values’ length.
• the validity’s length is not equal to offsets.len().
• The dtype’s crate::datatypes::PhysicalType is not equal to either crate::datatypes::PhysicalType::List or crate::datatypes::PhysicalType::LargeList.
• The dtype’s inner field’s data type is not equal to values.dtype.

Implementation

This function is O(1)

pub fn new( dtype: ArrowDataType, offsets: OffsetsBuffer<O>, values: Box<dyn Array>, validity: Option<Bitmap>, ) -> Self

Creates a new ListArray.

Panics

This function panics iff:

• The last offset is not equal to the values’ length.
• the validity’s length is not equal to offsets.len().
• The dtype’s crate::datatypes::PhysicalType is not equal to either crate::datatypes::PhysicalType::List or crate::datatypes::PhysicalType::LargeList.
• The dtype’s inner field’s data type is not equal to values.dtype.

Implementation

This function is O(1)

pub fn new_empty(dtype: ArrowDataType) -> Self

Returns a new empty ListArray.

pub fn new_null(dtype: ArrowDataType, length: usize) -> Self

Returns a new null ListArray.

impl<O: Offset> ListArray<O>

pub fn slice(&mut self, offset: usize, length: usize)

Slices this ListArray.

Panics

panics iff offset + length > self.len()

pub unsafe fn slice_unchecked(&mut self, offset: usize, length: usize)

Slices this ListArray.

Safety

The caller must ensure that offset + length < self.len().

pub fn sliced(self, offset: usize, length: usize) -> Self

Returns this array sliced.

Implementation

This function is O(1).

Panics

iff offset + length > self.len().

pub unsafe fn sliced_unchecked(self, offset: usize, length: usize) -> Self

Returns this array sliced.

Implementation

This function is O(1).

Safety

The caller must ensure that offset + length <= self.len().

pub fn with_validity(self, validity: Option<Bitmap>) -> Self

Returns this array with a new validity.

Panic

Panics iff validity.len() != self.len().

pub fn set_validity(&mut self, validity: Option<Bitmap>)

Sets the validity of this array.

Panics

This function panics iff values.len() != self.len().

pub fn take_validity(&mut self) -> Option<Bitmap>

Takes the validity of this array, leaving it without a validity mask.

pub fn boxed(self) -> Box<dyn Array>

Boxes this array into a Box<dyn Array>.

pub fn arced(self) -> Arc<dyn Array>

Arcs this array into a std::sync::Arc<dyn Array>.

pub fn trim_to_normalized_offsets_recursive(&self) -> Self

impl<O: Offset> ListArray<O>

pub fn len(&self) -> usize

Returns the length of this array

pub fn value(&self, i: usize) -> Box<dyn Array>

Returns the element at index i

Panic

Panics iff i >= self.len()

pub unsafe fn value_unchecked(&self, i: usize) -> Box<dyn Array>

Returns the element at index i as &str

Safety

Assumes that the i < self.len.

pub fn validity(&self) -> Option<&Bitmap>

The optional validity.

pub fn offsets(&self) -> &OffsetsBuffer<O>

The offsets [Buffer].

pub fn values(&self) -> &Box<dyn Array>

The values.

impl<O: Offset> ListArray<O>

pub fn default_datatype(dtype: ArrowDataType) -> ArrowDataType

Returns a default ArrowDataType: inner field is named “item” and is nullable

pub fn get_child_field(dtype: &ArrowDataType) -> &Field

Returns a the inner Field

Panics

Panics iff the logical type is not consistent with this struct.

pub fn try_get_child(dtype: &ArrowDataType) -> PolarsResult<&Field>

Returns a the inner Field

Errors

Panics iff the logical type is not consistent with this struct.

pub fn get_child_type(dtype: &ArrowDataType) -> &ArrowDataType

Returns a the inner ArrowDataType

Panics

Panics iff the logical type is not consistent with this struct.

Trait Implementations

impl<O: Offset> Array for ListArray<O>

fn as_any(&self) -> &dyn Any

Converts itself to a reference of Any, which enables downcasting to concrete types.

fn as_any_mut(&mut self) -> &mut dyn Any

Converts itself to a mutable reference of Any, which enables mutable downcasting to concrete types.

fn len(&self) -> usize

The length of the Array. Every array has a length corresponding to the number of elements (slots).

fn dtype(&self) -> &ArrowDataType

The ArrowDataType of the Array. In combination with Array::as_any, this can be used to downcast trait objects (dyn Array) to concrete arrays.

fn split_at_boxed(&self, offset: usize) -> (Box<dyn Array>, Box<dyn Array>)

Split Self at offset into two boxed Arrays where offset <= self.len().

unsafe fn split_at_boxed_unchecked( &self, offset: usize, ) -> (Box<dyn Array>, Box<dyn Array>)

Split Self at offset into two boxed Arrays without checking offset <= self.len().

fn slice(&mut self, offset: usize, length: usize)

Slices this Array.

unsafe fn slice_unchecked(&mut self, offset: usize, length: usize)

Slices the Array.

fn to_boxed(&self) -> Box<dyn Array>

Clone a &dyn Array to an owned Box<dyn Array>.

fn validity(&self) -> Option<&Bitmap>

The validity of the Array: every array has an optional Bitmap that, when available specifies whether the array slot is valid or not (null). When the validity is None, all slots are valid.

fn with_validity(&self, validity: Option<Bitmap>) -> Box<dyn Array>

Clones this Array with a new assigned bitmap.

fn is_empty(&self) -> bool

whether the array is empty

fn null_count(&self) -> usize

The number of null slots on this Array.

fn has_nulls(&self) -> bool

fn is_null(&self, i: usize) -> bool

Returns whether slot i is null.

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

Returns whether slot i is null.

fn is_valid(&self, i: usize) -> bool

Returns whether slot i is valid.

fn sliced(&self, offset: usize, length: usize) -> Box<dyn Array>

Returns a slice of this Array.

unsafe fn sliced_unchecked( &self, offset: usize, length: usize, ) -> Box<dyn Array>

Returns a slice of this Array.

impl<'a, O: Offset> ArrayAccessor<'a> for ListArray<O>

type Item = Box<dyn Array>

unsafe fn value_unchecked(&'a self, index: usize) -> Self::Item

Safety

fn len(&self) -> usize

impl<T: AsArray> ArrayFromIter<Option<T>> for ListArray<i64>

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

fn try_arr_from_iter<E, I: IntoIterator<Item = Result<Option<T>, E>>>( iter: I, ) -> Result<Self, E>

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

where I: IntoIterator<Item = T>, I::IntoIter: TrustedLen,

fn try_arr_from_iter_trusted<E, I>(iter: I) -> Result<Self, E>

where I: IntoIterator<Item = Result<T, E>>, I::IntoIter: TrustedLen,

impl<T: AsArray> ArrayFromIterDtype<Option<T>> for ListArray<i64>

fn arr_from_iter_with_dtype<I: IntoIterator<Item = Option<T>>>( dtype: ArrowDataType, iter: I, ) -> Self

fn try_arr_from_iter_with_dtype<E, I: IntoIterator<Item = Result<Option<T>, E>>>( dtype: ArrowDataType, iter: I, ) -> Result<Self, E>

fn arr_from_iter_trusted_with_dtype<I>(dtype: ArrowDataType, iter: I) -> Self

where I: IntoIterator<Item = T>, I::IntoIter: TrustedLen,

fn try_arr_from_iter_trusted_with_dtype<E, I>( dtype: ArrowDataType, iter: I, ) -> Result<Self, E>

where I: IntoIterator<Item = Result<T, E>>, I::IntoIter: TrustedLen,

impl<T: AsArray> ArrayFromIterDtype<T> for ListArray<i64>

fn arr_from_iter_with_dtype<I: IntoIterator<Item = T>>( dtype: ArrowDataType, iter: I, ) -> Self

fn try_arr_from_iter_with_dtype<E, I: IntoIterator<Item = Result<T, E>>>( dtype: ArrowDataType, iter: I, ) -> Result<Self, E>

fn arr_from_iter_trusted_with_dtype<I>(dtype: ArrowDataType, iter: I) -> Self

where I: IntoIterator<Item = T>, I::IntoIter: TrustedLen,

fn try_arr_from_iter_trusted_with_dtype<E, I>( dtype: ArrowDataType, iter: I, ) -> Result<Self, E>

where I: IntoIterator<Item = Result<T, E>>, I::IntoIter: TrustedLen,

impl<O: Clone + Offset> Clone for ListArray<O>

fn clone(&self) -> ListArray<O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: Offset> Debug for ListArray<O>

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

Formats the value using the given formatter.

impl<'a, O: Offset> From<GrowableList<'a, O>> for ListArray<O>

fn from(val: GrowableList<'a, O>) -> Self

Converts to this type from the input type.

impl<O: Offset, M: MutableArray> From<MutableListArray<O, M>> for ListArray<O>

fn from(other: MutableListArray<O, M>) -> Self

Converts to this type from the input type.

impl<'a, O: Offset> IntoIterator for &'a ListArray<O>

type Item = Option<Box<dyn Array>>

The type of the elements being iterated over.

type IntoIter = ZipValidity<Box<dyn Array>, ArrayValuesIter<'a, ListArray<O>>, BitmapIter<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl ListFromIter for ListArray<i64>

unsafe fn from_iter_primitive_trusted_len<T, P, I>( iter: I, dtype: ArrowDataType, ) -> ListArray<i64>

where T: NativeType, P: IntoIterator<Item = Option<T>>, I: IntoIterator<Item = Option<P>>,

Create a list-array from an iterator. Used in group_by agg-list

unsafe fn from_iter_bool_trusted_len<I, P>(iter: I) -> ListArray<i64>

where I: IntoIterator<Item = Option<P>>, P: IntoIterator<Item = Option<bool>>,

Create a list-array from an iterator. Used in group_by agg-list

unsafe fn from_iter_binview_trusted_len<I, P, Ref, T: ViewType + ?Sized>( iter: I, n_elements: usize, ) -> ListArray<i64>

where I: IntoIterator<Item = Option<P>>, P: IntoIterator<Item = Option<Ref>>, Ref: AsRef<T>,

Safety

unsafe fn from_iter_utf8_trusted_len<I, P, Ref>( iter: I, n_elements: usize, ) -> ListArray<i64>

where I: IntoIterator<Item = Option<P>>, P: IntoIterator<Item = Option<Ref>>, Ref: AsRef<str>,

Create a list-array from an iterator. Used in group_by agg-list

unsafe fn from_iter_binary_trusted_len<I, P, Ref>( iter: I, n_elements: usize, ) -> ListArray<i64>

where I: IntoIterator<Item = Option<P>>, P: IntoIterator<Item = Option<Ref>>, Ref: AsRef<[u8]>,

Create a list-array from an iterator. Used in group_by agg-list

impl<O: Offset> PartialEq<&(dyn Array + 'static)> for ListArray<O>

fn eq(&self, other: &&dyn Array) -> 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<O: Offset> PartialEq for ListArray<O>

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<O: Offset> Splitable for ListArray<O>

fn check_bound(&self, offset: usize) -> bool

unsafe fn _split_at_unchecked(&self, offset: usize) -> (Self, Self)

Internal implementation of split_at_unchecked. For any usage, prefer the using split_at or split_at_unchecked.

fn split_at(&self, offset: usize) -> (Self, Self)

Split Self at offset where offset <= self.len().

unsafe fn split_at_unchecked(&self, offset: usize) -> (Self, Self)

Split Self at offset without checking offset <= self.len().

impl StaticArray for ListArray<i64>

type ValueT<'a> = Box<dyn Array>

type ZeroableValueT<'a> = Option<Box<dyn Array>>

type ValueIterT<'a> = ArrayValuesIter<'a, ListArray<i64>>

unsafe fn value_unchecked(&self, idx: usize) -> Self::ValueT<'_>

Safety

fn values_iter(&self) -> Self::ValueIterT<'_>

fn iter( &self, ) -> ZipValidity<Self::ValueT<'_>, Self::ValueIterT<'_>, BitmapIter<'_>>

fn with_validity_typed(self, validity: Option<Bitmap>) -> Self

fn full_null(length: usize, dtype: ArrowDataType) -> Self

fn get(&self, idx: usize) -> Option<Self::ValueT<'_>>

unsafe fn get_unchecked(&self, idx: usize) -> Option<Self::ValueT<'_>>

Safety

fn last(&self) -> Option<Self::ValueT<'_>>

fn value(&self, idx: usize) -> Self::ValueT<'_>

fn as_slice(&self) -> Option<&[Self::ValueT<'_>]>

fn from_vec(v: Vec<Self::ValueT<'_>>, dtype: ArrowDataType) -> Self

fn from_zeroable_vec( v: Vec<Self::ZeroableValueT<'_>>, dtype: ArrowDataType, ) -> Self

fn full(length: usize, value: Self::ValueT<'_>, dtype: ArrowDataType) -> Self

impl ValueSize for ListArray<i64>

fn get_values_size(&self) -> usize

Get the values size that is still “visible” to the underlying array. E.g. take the offsets into account.

impl ArrowArray for ListArray<i64>