Struct arrow::array::TypedDictionaryArray
source · pub struct TypedDictionaryArray<'a, K, V>where
K: ArrowDictionaryKeyType,{ /* private fields */ }
Expand description
A strongly-typed wrapper around a DictionaryArray
that 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)
}
Implementations§
source§impl<'a, K, V> TypedDictionaryArray<'a, K, V>where
K: ArrowDictionaryKeyType,
impl<'a, K, V> TypedDictionaryArray<'a, K, V>where K: ArrowDictionaryKeyType,
sourcepub fn keys(&self) -> &'a PrimitiveArray<K>
pub fn keys(&self) -> &'a PrimitiveArray<K>
Returns the keys of this TypedDictionaryArray
sourcepub fn values(&self) -> &'a V
pub fn values(&self) -> &'a V
Returns the values of this TypedDictionaryArray
Trait Implementations§
source§impl<'a, K, V> Array for TypedDictionaryArray<'a, K, V>where
K: ArrowDictionaryKeyType,
V: Sync,
impl<'a, K, V> Array for TypedDictionaryArray<'a, K, V>where K: ArrowDictionaryKeyType, V: Sync,
source§fn data(&self) -> &ArrayData
fn data(&self) -> &ArrayData
Returns a reference to the underlying data of this array Read more
source§fn slice(&self, offset: usize, length: usize) -> Arc<dyn Array + 'static>
fn slice(&self, offset: usize, length: usize) -> Arc<dyn Array + 'static>
Returns a zero-copy slice of this array with the indicated offset and length. Read more
source§fn nulls(&self) -> Option<&NullBuffer>
fn nulls(&self) -> Option<&NullBuffer>
Returns the null buffers of this array if any
source§fn data_ref(&self) -> &ArrayData
fn data_ref(&self) -> &ArrayData
Returns a reference-counted pointer to the underlying data of this array. Read more
source§fn offset(&self) -> usize
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 moresource§fn is_null(&self, index: usize) -> bool
fn is_null(&self, index: usize) -> bool
Returns whether the element at
index
is null.
When using this function on a slice, the index is relative to the slice. Read moresource§fn is_valid(&self, index: usize) -> bool
fn is_valid(&self, index: usize) -> bool
Returns whether the element at
index
is not null.
When using this function on a slice, the index is relative to the slice. Read moresource§fn null_count(&self) -> usize
fn null_count(&self) -> usize
Returns the total number of null values in this array. Read more
source§fn get_buffer_memory_size(&self) -> usize
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.
source§fn get_array_memory_size(&self) -> usize
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§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,
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
type Item = <&'a V as ArrayAccessor>::Item
The Arrow type of the element being accessed.
source§fn value(
&self,
index: usize
) -> <TypedDictionaryArray<'a, K, V> as ArrayAccessor>::Item
fn value( &self, index: usize ) -> <TypedDictionaryArray<'a, K, V> as ArrayAccessor>::Item
Returns the element at index
i
Read moresource§unsafe fn value_unchecked(
&self,
index: usize
) -> <TypedDictionaryArray<'a, K, V> as ArrayAccessor>::Item
unsafe fn value_unchecked( &self, index: usize ) -> <TypedDictionaryArray<'a, K, V> as ArrayAccessor>::Item
Returns the element at index
i
Read moresource§impl<'a, K, V> Clone for TypedDictionaryArray<'a, K, V>where
K: ArrowDictionaryKeyType,
impl<'a, K, V> Clone for TypedDictionaryArray<'a, K, V>where K: ArrowDictionaryKeyType,
source§fn clone(&self) -> TypedDictionaryArray<'a, K, V>
fn clone(&self) -> TypedDictionaryArray<'a, K, V>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<'a, K, V> Debug for TypedDictionaryArray<'a, K, V>where
K: ArrowDictionaryKeyType,
impl<'a, K, V> Debug for TypedDictionaryArray<'a, K, V>where K: ArrowDictionaryKeyType,
source§impl<'a, K, V> IntoIterator for TypedDictionaryArray<'a, K, V>where
K: ArrowDictionaryKeyType,
TypedDictionaryArray<'a, K, V>: ArrayAccessor,
impl<'a, K, V> IntoIterator for TypedDictionaryArray<'a, K, V>where K: ArrowDictionaryKeyType, TypedDictionaryArray<'a, K, V>: ArrayAccessor,
§type Item = Option<<TypedDictionaryArray<'a, K, V> as ArrayAccessor>::Item>
type Item = Option<<TypedDictionaryArray<'a, K, V> as ArrayAccessor>::Item>
The type of the elements being iterated over.
§type IntoIter = ArrayIter<TypedDictionaryArray<'a, K, V>>
type IntoIter = ArrayIter<TypedDictionaryArray<'a, K, V>>
Which kind of iterator are we turning this into?
source§fn into_iter(self) -> <TypedDictionaryArray<'a, K, V> as IntoIterator>::IntoIter
fn into_iter(self) -> <TypedDictionaryArray<'a, K, V> as IntoIterator>::IntoIter
Creates an iterator from a value. Read more