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

source · [−]

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

Expand description

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

Implementations

source

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

source

pub fn iter(
&'a self
) -> ZipValidity<'a, Box<dyn Array + 'static, Global>, ListValuesIter<'a, ListArray<O>>>ⓘNotable traits for ZipValidity<'a, T, I>`impl<'a, T, I> Iterator for ZipValidity<'a, T, I> where I: Iterator<Item = T>, type Item = Option<T>;`

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

source

pub fn values_iter(&'a self) -> ListValuesIter<'a, ListArray<O>>ⓘNotable traits for ListValuesIter<'a, A>`impl<'a, A> Iterator for ListValuesIter<'a, A> where A: IterableListArray, type Item = Box<dyn Array + 'static, Global>;`

Returns an iterator of Box<dyn Array>

source

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

source

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)

source

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)

source

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

Alias of new

source

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

Returns a new empty ListArray.

source

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

Returns a new null ListArray.

source

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

source

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

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

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

source

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

Returns a slice of this ListArray.

Panics

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

source

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().

source

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().

source

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

source

pub fn len(&self) -> usize

Returns the length of this array

source

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

Returns the element at index i

source

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

Returns the element at index i as &str

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

The optional validity.

source

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

The offsets Buffer.

source

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

The values.

source

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

source

pub fn default_datatype(data_type: DataType) -> DataType

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

source

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.

source

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

source

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

source

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

Convert to trait object.

source

fn len(&self) -> usize

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

source

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. Read more

source

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. Read more

source

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

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

source

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

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

source

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

Sets the validity bitmap on this Array. Read more

source

fn is_empty(&self) -> bool

whether the array is empty

source

fn null_count(&self) -> usize

The number of null slots on this Array. Read more

source

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

Returns whether slot i is null. Read more

source

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

Returns whether slot i is valid. Read more

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

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

Performs the conversion.

source

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

source

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

Performs the conversion.

source

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?

source

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

Creates an iterator from a value. Read more

source

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

Create a list-array from an iterator. Used in groupby agg-list Read more

source

unsafe fn from_iter_bool_trusted_len<I, P>(iter: I) -> ListArray<i64> where
I: IntoIterator<Item = Option>,
P: IntoIterator<Item = Option<bool>>,

Create a list-array from an iterator. Used in groupby agg-list Read more

source

unsafe fn from_iter_utf8_trusted_len<I, P, Ref>(
 iter: I,
 n_elements: usize
) -> ListArray<i64> where
 I: IntoIterator<Item = Option>,
 P: IntoIterator<Item = Option<Ref>>,
 Ref: AsRef<str>,

Create a list-array from an iterator. Used in groupby agg-list Read more

source

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

source

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

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

1.0.0 · source

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

This method tests for !=.

source

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

source

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

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

1.0.0 · source

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

This method tests for !=.

source

impl ValueSize for ListArray<i64>

source

fn get_values_size(&self) -> usize

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

source

impl ArrowArray for ListArray<i64>

Auto Trait Implementations

impl<O> !RefUnwindSafe for ListArray<O>

impl<O> Send for ListArray<O>

impl<O> Sync for ListArray<O>

impl<O> Unpin for ListArray<O>

impl<O> !UnwindSafe for ListArray<O>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<A> IsValid for A where
A: ArrowArray,

source

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

Safety Read more

source

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

Safety Read more

source

impl<T> Pointable for T

source

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

source

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

source

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

source

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

source

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<A> PolarsArray for A where
A: Array + ?Sized,

source

fn has_validity(&self) -> bool

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

source

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

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>>>ⓘNotable traits for ZipValidity<'a, T, I>impl<'a, T, I> Iterator for ZipValidity<'a, T, I> where I: Iterator<Item = T>, type Item = Option<T>;

pub fn values_iter(&'a self) -> ListValuesIter<'a, ListArray<O>>ⓘNotable traits for ListValuesIter<'a, A>impl<'a, A> Iterator for ListValuesIter<'a, A> where A: IterableListArray, type Item = Box<dyn Array + 'static, Global>;

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>

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

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

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

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

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>

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

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

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

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

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

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

pub fn len(&self) -> usize

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

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

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

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

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

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

pub fn default_datatype(data_type: DataType) -> DataType

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

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

Trait Implementations

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

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

fn len(&self) -> usize

fn data_type(&self) -> &DataType

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

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

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

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

fn is_empty(&self) -> bool

fn null_count(&self) -> usize

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

unsafe fn from_iter_bool_trusted_len<I, P>(iter: I) -> ListArray<i64> where I: IntoIterator<Item = Option<P>>, P: IntoIterator<Item = Option<bool>>,

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

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

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

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

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

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

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

impl ValueSize for ListArray<i64>

fn get_values_size(&self) -> usize

impl ArrowArray for ListArray<i64>

Auto Trait Implementations

impl<O> !RefUnwindSafe for ListArray<O>

impl<O> Send for ListArray<O>

impl<O> Sync for ListArray<O>

impl<O> Unpin for ListArray<O>

impl<O> !UnwindSafe for ListArray<O>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

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

pub fn iter(
&'a self
) -> ZipValidity<'a, Box<dyn Array + 'static, Global>, ListValuesIter<'a, ListArray<O>>>ⓘNotable traits for ZipValidity<'a, T, I>`impl<'a, T, I> Iterator for ZipValidity<'a, T, I> where I: Iterator<Item = T>, type Item = Option<T>;`

pub fn values_iter(&'a self) -> ListValuesIter<'a, ListArray<O>>ⓘNotable traits for ListValuesIter<'a, A>`impl<'a, A> Iterator for ListValuesIter<'a, A> where A: IterableListArray, type Item = Box<dyn Array + 'static, Global>;`

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>

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

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

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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

unsafe fn from_iter_bool_trusted_len<I, P>(iter: I) -> ListArray<i64> where
I: IntoIterator<Item = Option<P>>,
P: IntoIterator<Item = Option<bool>>,

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<A> IsValid for A where
A: ArrowArray,

impl<A> PolarsArray for A where
A: Array + ?Sized,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,