Struct polars::export::arrow::array::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<'a, Box<dyn Array + 'static, Global>, MapValuesIter<'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(
    data_type: DataType,
    offsets: Buffer<i32>,
    field: Arc<dyn Array + 'static>,
    validity: Option<Bitmap>
) -> Result<MapArray, ArrowError>

Returns a new MapArray.

Errors

This function errors iff:

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

pub fn new(
    data_type: DataType,
    offsets: Buffer<i32>,
    field: Arc<dyn Array + 'static>,
    validity: Option<Bitmap>
) -> MapArray

Creates a new MapArray.

Panics

• the offsets are not monotonically increasing
• The last offset is not equal to the field’ length.
• The data_type’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 from_data(
    data_type: DataType,
    offsets: Buffer<i32>,
    field: Arc<dyn Array + 'static>,
    validity: Option<Bitmap>
) -> MapArray

Alias for new

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

Returns a new null MapArray of length.

pub fn new_empty(data_type: DataType) -> MapArray

Returns a new empty MapArray.

impl MapArray

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

Returns a slice of this MapArray.

Panics

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

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

Returns a slice of this MapArray.

Safety

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

impl MapArray

pub fn len(&self) -> usize

Returns the length of this array

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

returns the offsets

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

Returns the field (guaranteed to be a Struct)

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.

Safety

Assumes that the i < self.len.

Trait Implementations

impl Array for MapArray

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 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 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<(), Error>

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a MapArray

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>, MapValuesIter<'a>>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.