arrow_array::array::map_array

Struct MapArray

Source
pub struct MapArray {
    data_type: DataType,
    nulls: Option<NullBuffer>,
    entries: StructArray,
    value_offsets: OffsetBuffer<i32>,
}
Expand description

An array of key-value maps

Keys should always be non-null, but values can be null.

MapArray is physically a ListArray of key values pairs stored as an entries StructArray with 2 child fields.

See MapBuilder for how to construct a MapArray

Fields§

§data_type: DataType§nulls: Option<NullBuffer>§entries: StructArray

The StructArray that is the direct child of this array

§value_offsets: OffsetBuffer<i32>

The start and end offsets of each entry

Implementations§

Source§

impl MapArray

Source

pub fn try_new( field: FieldRef, offsets: OffsetBuffer<i32>, entries: StructArray, nulls: Option<NullBuffer>, ordered: bool, ) -> Result<Self, ArrowError>

Create a new MapArray from the provided parts

See MapBuilder for a higher-level interface to construct a MapArray

§Errors

Errors if

  • offsets.len() - 1 != nulls.len()
  • offsets.last() > entries.len()
  • field.is_nullable()
  • entries.null_count() != 0
  • entries.columns().len() != 2
  • field.data_type() != entries.data_type()
Source

pub fn new( field: FieldRef, offsets: OffsetBuffer<i32>, entries: StructArray, nulls: Option<NullBuffer>, ordered: bool, ) -> Self

Create a new MapArray from the provided parts

See MapBuilder for a higher-level interface to construct a MapArray

§Panics

Panics if Self::try_new returns an error

Source

pub fn into_parts( self, ) -> (FieldRef, OffsetBuffer<i32>, StructArray, Option<NullBuffer>, bool)

Deconstruct this array into its constituent parts

Source

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

Returns a reference to the offsets of this map

Unlike Self::value_offsets this returns the [OffsetBuffer] allowing for zero-copy cloning

Source

pub fn keys(&self) -> &ArrayRef

Returns a reference to the keys of this map

Source

pub fn values(&self) -> &ArrayRef

Returns a reference to the values of this map

Source

pub fn entries(&self) -> &StructArray

Returns a reference to the StructArray entries of this map

Source

pub fn key_type(&self) -> &DataType

Returns the data type of the map’s keys.

Source

pub fn value_type(&self) -> &DataType

Returns the data type of the map’s values.

Source

pub unsafe fn value_unchecked(&self, i: usize) -> StructArray

Returns ith value of this map array.

§Safety

Caller must ensure that the index is within the array bounds

Source

pub fn value(&self, i: usize) -> StructArray

Returns ith value of this map array.

This is a StructArray containing two fields

Source

pub fn value_offsets(&self) -> &[i32]

Returns the offset values in the offsets buffer

Source

pub fn value_length(&self, i: usize) -> i32

Returns the length for value at index i.

Source

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

Returns a zero-copy slice of this array with the indicated offset and length.

Source

pub fn iter(&self) -> MapArrayIter<'_>

constructs a new iterator

Source§

impl MapArray

Source

fn try_new_from_array_data(data: ArrayData) -> Result<Self, ArrowError>

Source

pub fn new_from_strings<'a>( keys: impl Iterator<Item = &'a str>, values: &dyn Array, entry_offsets: &[u32], ) -> Result<Self, ArrowError>

Creates map array from provided keys, values and entry_offsets.

Trait Implementations§

Source§

impl Array for MapArray

Source§

fn as_any(&self) -> &dyn Any

Returns the array as Any so that it can be downcasted to a specific implementation. Read more
Source§

fn to_data(&self) -> ArrayData

Returns the underlying data of this array
Source§

fn into_data(self) -> ArrayData

Returns the underlying data of this array Read more
Source§

fn data_type(&self) -> &DataType

Returns a reference to the [DataType] of this array. Read more
Source§

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

Returns a zero-copy slice of this array with the indicated offset and length. Read more
Source§

fn len(&self) -> usize

Returns the length (i.e., number of elements) of this array. Read more
Source§

fn is_empty(&self) -> bool

Returns whether this array is empty. Read more
Source§

fn offset(&self) -> usize

Returns the offset into the underlying data used by this array(-slice). Note that the underlying data can be shared by many arrays. This defaults to 0. Read more
Source§

fn nulls(&self) -> Option<&NullBuffer>

Returns the null buffer of this array if any. Read more
Source§

fn get_buffer_memory_size(&self) -> usize

Returns the total number of bytes of memory pointed to by this array. The buffers store bytes in the Arrow memory format, and include the data as well as the validity map. Note that this does not always correspond to the exact memory usage of an array, since multiple arrays can share the same buffers or slices thereof.
Source§

fn get_array_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied physically by this array. This value will always be greater than returned by get_buffer_memory_size() and includes the overhead of the data structures that contain the pointers to the various buffers.
Source§

fn logical_nulls(&self) -> Option<NullBuffer>

Returns a potentially computed [NullBuffer] that represents the logical null values of this array, if any. Read more
Source§

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

Returns whether the element at index is null according to Array::nulls Read more
Source§

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

Returns whether the element at index is not null, the opposite of Self::is_null. Read more
Source§

fn null_count(&self) -> usize

Returns the total number of physical null values in this array. Read more
Source§

fn logical_null_count(&self) -> usize

Returns the total number of logical null values in this array. Read more
Source§

fn is_nullable(&self) -> bool

Returns false if the array is guaranteed to not contain any logical nulls Read more
Source§

impl ArrayAccessor for &MapArray

Source§

type Item = StructArray

The Arrow type of the element being accessed.
Source§

fn value(&self, index: usize) -> Self::Item

Returns the element at index i Read more
Source§

unsafe fn value_unchecked(&self, index: usize) -> Self::Item

Returns the element at index i Read more
Source§

impl Clone for MapArray

Source§

fn clone(&self) -> MapArray

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

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<ArrayData> for MapArray

Source§

fn from(data: ArrayData) -> Self

Converts to this type from the input type.
Source§

impl From<MapArray> for ArrayData

Source§

fn from(array: MapArray) -> Self

Converts to this type from the input type.
Source§

impl From<MapArray> for ListArray

Source§

fn from(value: MapArray) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for MapArray

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> Datum for T
where T: Array,

Source§

fn get(&self) -> (&dyn Array, bool)

Returns the value for this Datum and a boolean indicating if the value is scalar
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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<T> ToOwned for T
where T: Clone,

Source§

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)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.