Struct polars::export::arrow::array::ListArray

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

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

Implementations

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

pub fn iter(
    &'a self
) -> ZipValidity<'a, Box<dyn Array + 'static, Global>, ListValuesIter<'a, ListArray<O>>>

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

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

Returns an iterator of Box<dyn Array>

impl<O> ListArray<O> where
    O: Offset, 

pub fn try_new(
    data_type: DataType,
    offsets: Buffer<O>,
    values: Arc<dyn Array + 'static>,
    validity: Option<Bitmap>
) -> Result<ListArray<O>, ArrowError>

Creates a new ListArray.

Errors

This function returns an error iff:

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

Implementation

This function is O(N) - checking monotinicity is O(N)

pub fn new(
    data_type: DataType,
    offsets: Buffer<O>,
    values: Arc<dyn Array + 'static>,
    validity: Option<Bitmap>
) -> ListArray<O>

Creates a new ListArray.

Panics

This function panics iff:

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

Implementation

This function is O(N) - checking monotinicity is O(N)

pub fn from_data(
    data_type: DataType,
    offsets: Buffer<O>,
    values: Arc<dyn Array + 'static>,
    validity: Option<Bitmap>
) -> ListArray<O>

Alias of new

pub fn new_empty(data_type: DataType) -> ListArray<O>

Returns a new empty ListArray.

pub fn new_null(data_type: DataType, length: usize) -> ListArray<O>

Returns a new null ListArray.

impl<O> ListArray<O> where
    O: Offset, 

pub unsafe fn try_new_unchecked(
    data_type: DataType,
    offsets: Buffer<O>,
    values: Arc<dyn Array + 'static>,
    validity: Option<Bitmap>
) -> Result<ListArray<O>, ArrowError>

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() - 1.
• The data_type’s crate::datatypes::PhysicalType is not equal to either crate::datatypes::PhysicalType::List or crate::datatypes::PhysicalType::LargeList.
• The data_type’s inner field’s data type is not equal to values.data_type.

Safety

This function is unsafe iff:

• the offsets are not monotonically increasing

Implementation

This function is O(1)

pub unsafe fn new_unchecked(
    data_type: DataType,
    offsets: Buffer<O>,
    values: Arc<dyn Array + 'static>,
    validity: Option<Bitmap>
) -> ListArray<O>

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() - 1.
• The data_type’s crate::datatypes::PhysicalType is not equal to either crate::datatypes::PhysicalType::List or crate::datatypes::PhysicalType::LargeList.
• The data_type’s inner field’s data type is not equal to values.data_type.

Safety

This function is unsafe iff:

• the offsets are not monotonically increasing

Implementation

This function is O(1)

impl<O> ListArray<O> where
    O: Offset, 

pub fn slice(&self, offset: usize, length: usize) -> ListArray<O>

Returns a slice of this ListArray.

Panics

panics iff offset + length >= self.len()

pub unsafe fn slice_unchecked(
    &self,
    offset: usize,
    length: usize
) -> ListArray<O>

Returns a slice of this ListArray.

Safety

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

pub fn with_validity(&self, validity: Option<Bitmap>) -> ListArray<O>

Sets the validity bitmap on this ListArray.

Panic

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

impl<O> ListArray<O> where
    O: Offset, 

pub fn len(&self) -> usize

Returns the length of this array

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

Returns the element at index i

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

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) -> &Buffer<O>

The offsets Buffer.

pub fn values(&self) -> &Arc<dyn Array + 'static>

The values.

impl<O> ListArray<O> where
    O: Offset, 

pub fn default_datatype(data_type: DataType) -> DataType

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

pub fn get_child_field(data_type: &DataType) -> &Field

Returns a the inner Field

Panics

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

pub fn get_child_type(data_type: &DataType) -> &DataType

Returns a the inner DataType

Panics

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

Trait Implementations

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

fn as_any(&self) -> &(dyn Any + 'static)

Convert to trait object.

fn len(&self) -> usize

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

fn data_type(&self) -> &DataType

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

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 slice(
    &self,
    offset: usize,
    length: usize
) -> Box<dyn Array + 'static, Global>

Slices the Array, returning a new Box<dyn Array>.

unsafe fn slice_unchecked(
    &self,
    offset: usize,
    length: usize
) -> Box<dyn Array + 'static, Global>

Slices the Array, returning a new Box<dyn Array>.

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

Sets the validity bitmap on this Array.

fn to_boxed(&self) -> Box<dyn Array + 'static, Global>

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

fn is_empty(&self) -> bool

whether the array is empty

fn null_count(&self) -> usize

The number of null slots on this Array.

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

Returns whether slot i is null.

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

Returns whether slot i is valid.

impl ArrowGetItem for ListArray<i64>

type Item = Box<dyn Array + 'static, Global>

fn get(&self, item: usize) -> Option<<ListArray<i64> as ArrowGetItem>::Item>

unsafe fn get_unchecked(
    &self,
    item: usize
) -> Option<<ListArray<i64> as ArrowGetItem>::Item>

Safety

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

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> Debug for ListArray<O> where
    O: Offset, 

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

type Item = Option<Box<dyn Array + 'static, Global>>

The type of the elements being iterated over.

type IntoIter = ZipValidity<'a, Box<dyn Array + 'static, Global>, ListValuesIter<'a, ListArray<O>>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a ListArray<O> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<O> IterableListArray for ListArray<O> where
    O: Offset, 

unsafe fn value_unchecked(&self, i: usize) -> Box<dyn Array + 'static, Global>

Safety

impl ListFromIter for ListArray<i64>

unsafe fn from_iter_primitive_trusted_len<T, P, I>(
    iter: I,
    data_type: DataType
) -> ListArray<i64> where
    T: NativeType,
    P: IntoIterator<Item = Option<T>>,
    I: IntoIterator<Item = Option<P>>, 

Create a list-array from an iterator. Used in groupby 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 groupby agg-list

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 groupby agg-list

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

fn eq(&self, other: &&dyn Array) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<O> PartialEq<ListArray<O>> for ListArray<O> where
    O: Offset, 

fn eq(&self, other: &ListArray<O>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl ValueSize for ListArray<i64>

fn get_values_size(&self) -> usize

Useful for a Utf8 or a List to get underlying value size. During a rechunk this is handy

impl ArrowArray for ListArray<i64>