Struct TypedDictionaryArray

pub struct TypedDictionaryArray<'a, K, V>
where
    K: ArrowDictionaryKeyType,
{
    dictionary: &'a DictionaryArray<K>,
    values: &'a V,
}

A DictionaryArray typed on its child values array

Implements ArrayAccessor allowing fast access to its elements

use arrow_array::{DictionaryArray, StringArray, types::Int32Type};

let orig = ["a", "b", "a", "b"];
let dictionary = DictionaryArray::<Int32Type>::from_iter(orig);

// `TypedDictionaryArray` allows you to access the values directly
let typed = dictionary.downcast_dict::<StringArray>().unwrap();

for (maybe_val, orig) in typed.into_iter().zip(orig) {
    assert_eq!(maybe_val.unwrap(), orig)
}

Fields

dictionary: &'a DictionaryArray<K>

values: &'a V

Implementations

impl<'a, K, V> TypedDictionaryArray<'a, K, V>

where K: ArrowDictionaryKeyType,

pub fn keys(&self) -> &'a PrimitiveArray<K>

Returns the keys of this TypedDictionaryArray

pub fn values(&self) -> &'a V

Returns the values of this TypedDictionaryArray

Trait Implementations

impl<K, V> Array for TypedDictionaryArray<'_, K, V>

where K: ArrowDictionaryKeyType, V: Sync,

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

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

fn to_data(&self) -> ArrayData

Returns the underlying data of this array

fn into_data(self) -> ArrayData

Returns the underlying data of this array

fn data_type(&self) -> &DataType

Returns a reference to the DataType of this array.

fn slice(&self, offset: usize, length: usize) -> Arc<dyn Array>

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

fn len(&self) -> usize

Returns the length (i.e., number of elements) of this array.

fn is_empty(&self) -> bool

Returns whether this array is empty.

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.

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

Returns the null buffer of this array if any.

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

Returns a potentially computed NullBuffer that represents the logical null values of this array, if any.

fn logical_null_count(&self) -> usize

Returns the total number of logical null values in this array.

fn is_nullable(&self) -> bool

Returns false if the array is guaranteed to not contain any logical nulls

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.

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.

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

Returns whether the element at index is null according to Array::nulls

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

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

fn null_count(&self) -> usize

Returns the total number of physical null values in this array.

impl<'a, K, V> ArrayAccessor for TypedDictionaryArray<'a, K, V>

where K: ArrowDictionaryKeyType, V: Sync + Send, &'a V: ArrayAccessor, <&'a V as ArrayAccessor>::Item: Default,

type Item = <&'a V as ArrayAccessor>::Item

The Arrow type of the element being accessed.

fn value( &self, index: usize, ) -> <TypedDictionaryArray<'a, K, V> as ArrayAccessor>::Item

Returns the element at index i

unsafe fn value_unchecked( &self, index: usize, ) -> <TypedDictionaryArray<'a, K, V> as ArrayAccessor>::Item

Returns the element at index i

impl<K, V> Clone for TypedDictionaryArray<'_, K, V>

where K: ArrowDictionaryKeyType,

fn clone(&self) -> TypedDictionaryArray<'_, K, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V> Debug for TypedDictionaryArray<'_, K, V>

where K: ArrowDictionaryKeyType,

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

Formats the value using the given formatter.

impl<K, V> IntoIterator for TypedDictionaryArray<'_, K, V>

where K: ArrowDictionaryKeyType, TypedDictionaryArray<'_, K, V>: ArrayAccessor,

type Item = Option<<TypedDictionaryArray<'_, K, V> as ArrayAccessor>::Item>

The type of the elements being iterated over.

type IntoIter = ArrayIter<TypedDictionaryArray<'_, K, V>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <TypedDictionaryArray<'_, K, V> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<K, V> Copy for TypedDictionaryArray<'_, K, V>

where K: ArrowDictionaryKeyType,