Struct arrow2::array::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<'a, Box<dyn Array>, 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: Offset> ListArray<O>

pub fn try_new(
    data_type: DataType,
    offsets: Buffer<O>,
    values: Box<dyn Array>,
    validity: Option<Bitmap>
) -> Result<Self, Error>

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: Box<dyn Array>,
    validity: Option<Bitmap>
) -> Self

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: Box<dyn Array>,
    validity: Option<Bitmap>
) -> Self

Alias of new

pub fn new_empty(data_type: DataType) -> Self

Returns a new empty ListArray.

pub fn new_null(data_type: DataType, length: usize) -> Self

Returns a new null ListArray.

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

Boxes self into a Box<dyn Array>.

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

Boxes self into a Arc<dyn Array>.

impl<O: Offset> ListArray<O>

pub unsafe fn try_new_unchecked(
    data_type: DataType,
    offsets: Buffer<O>,
    values: Box<dyn Array>,
    validity: Option<Bitmap>
) -> Result<Self, Error>

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: 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() - 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: Offset> ListArray<O>

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

Returns a slice of this ListArray.

Panics

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

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

Returns a slice of this ListArray.

Safety

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

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

Returns this ListArray with a new validity.

Panic

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

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

Sets the validity of this ListArray.

Panics

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

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

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

The offsets Buffer.

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

The values.

impl<O: Offset> ListArray<O>

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 try_get_child(data_type: &DataType) -> Result<&Field, Error>

Returns a the inner Field

Errors

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: 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 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>

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

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

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

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

Clones this Array with a new new assigned bitmap.

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

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<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 + '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) -> Self::IntoIter

Creates an iterator from a value.

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

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

Safety

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

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn eq(&self, other: &Self) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.