Struct MapArray

pub struct MapArray { /* private fields */ }

An array representing a (key, value), both of arbitrary logical types.

Implementations

impl<'a> MapArray

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

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

pub fn values_iter(&'a self) -> MapValuesIter<'a>

Returns an iterator of Box<dyn Array>

impl MapArray

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

Returns a new MapArray.

Errors

This function errors iff:

• The last offset is not equal to the field’ length
• The dtype’s physical type is not crate::datatypes::PhysicalType::Map
• The fields’ dtype is not equal to the inner field of dtype
• The validity is not None and its length is different from offsets.len() - 1.

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

Creates a new MapArray.

Panics

• The last offset is not equal to the field’ length.
• The dtype’s physical type is not crate::datatypes::PhysicalType::Map,
• The validity is not None and its length is different from offsets.len() - 1.

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

Returns a new null MapArray of length.

pub fn new_empty(dtype: ArrowDataType) -> Self

Returns a new empty MapArray.

impl MapArray

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

Returns a slice of this MapArray.

Panics

panics iff offset + length > self.len()

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

Returns a slice of this MapArray.

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

impl MapArray

pub fn len(&self) -> usize

Returns the length of this array

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

returns the offsets

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

Returns the field (guaranteed to be a Struct)

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.

Safety

Assumes that the i < self.len.

Trait Implementations

impl Array for MapArray

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 Clone for MapArray

fn clone(&self) -> MapArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MapArray

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a MapArray

type Item = Option<Box<dyn Array>>

The type of the elements being iterated over.

type IntoIter = ZipValidity<Box<dyn Array>, MapValuesIter<'a>, BitmapIter<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<&(dyn Array + 'static)> for MapArray

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 PartialEq for MapArray

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 Splitable for MapArray

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