Struct arrow::array::PrimitiveDictionaryBuilder
source · [−]pub struct PrimitiveDictionaryBuilder<K, V> where
K: ArrowPrimitiveType,
V: ArrowPrimitiveType, { /* private fields */ }
Expand description
Array builder for DictionaryArray
. For example to map a set of byte indices
to f32 values. Note that the use of a HashMap
here will not scale to very large
arrays or result in an ordered dictionary.
Example:
use arrow::array::{
Array, PrimitiveBuilder, PrimitiveDictionaryBuilder,
UInt8Array, UInt32Array,
};
use arrow::datatypes::{UInt8Type, UInt32Type};
let key_builder = PrimitiveBuilder::<UInt8Type>::new(3);
let value_builder = PrimitiveBuilder::<UInt32Type>::new(2);
let mut builder = PrimitiveDictionaryBuilder::new(key_builder, value_builder);
builder.append(12345678).unwrap();
builder.append_null().unwrap();
builder.append(22345678).unwrap();
let array = builder.finish();
assert_eq!(
array.keys(),
&UInt8Array::from(vec![Some(0), None, Some(1)])
);
// Values are polymorphic and so require a downcast.
let av = array.values();
let ava: &UInt32Array = av.as_any().downcast_ref::<UInt32Array>().unwrap();
let avs: &[u32] = ava.values();
assert!(!array.is_null(0));
assert!(array.is_null(1));
assert!(!array.is_null(2));
assert_eq!(avs, &[12345678, 22345678]);
Implementations
sourceimpl<K, V> PrimitiveDictionaryBuilder<K, V> where
K: ArrowPrimitiveType,
V: ArrowPrimitiveType,
impl<K, V> PrimitiveDictionaryBuilder<K, V> where
K: ArrowPrimitiveType,
V: ArrowPrimitiveType,
sourcepub fn new(
keys_builder: PrimitiveBuilder<K>,
values_builder: PrimitiveBuilder<V>
) -> Self
pub fn new(
keys_builder: PrimitiveBuilder<K>,
values_builder: PrimitiveBuilder<V>
) -> Self
Creates a new PrimitiveDictionaryBuilder
from a keys builder and a value builder.
sourceimpl<K, V> PrimitiveDictionaryBuilder<K, V> where
K: ArrowPrimitiveType,
V: ArrowPrimitiveType,
impl<K, V> PrimitiveDictionaryBuilder<K, V> where
K: ArrowPrimitiveType,
V: ArrowPrimitiveType,
sourcepub fn append(&mut self, value: V::Native) -> Result<K::Native>
pub fn append(&mut self, value: V::Native) -> Result<K::Native>
Append a primitive value to the array. Return an existing index if already present in the values array or a new index if the value is appended to the values array.
pub fn append_null(&mut self) -> Result<()>
sourcepub fn finish(&mut self) -> DictionaryArray<K>
pub fn finish(&mut self) -> DictionaryArray<K>
Builds the DictionaryArray
and reset this builder.
Trait Implementations
sourceimpl<K, V> ArrayBuilder for PrimitiveDictionaryBuilder<K, V> where
K: ArrowPrimitiveType,
V: ArrowPrimitiveType,
impl<K, V> ArrayBuilder for PrimitiveDictionaryBuilder<K, V> where
K: ArrowPrimitiveType,
V: ArrowPrimitiveType,
sourcefn as_any_mut(&mut self) -> &mut dyn Any
fn as_any_mut(&mut self) -> &mut dyn Any
Returns the builder as an mutable Any
reference.
sourcefn into_box_any(self: Box<Self>) -> Box<dyn Any>
fn into_box_any(self: Box<Self>) -> Box<dyn Any>
Returns the boxed builder as a box of Any
.
sourceimpl<K: Debug, V: Debug> Debug for PrimitiveDictionaryBuilder<K, V> where
K: ArrowPrimitiveType,
V: ArrowPrimitiveType,
K::Native: Debug,
impl<K: Debug, V: Debug> Debug for PrimitiveDictionaryBuilder<K, V> where
K: ArrowPrimitiveType,
V: ArrowPrimitiveType,
K::Native: Debug,
Auto Trait Implementations
impl<K, V> RefUnwindSafe for PrimitiveDictionaryBuilder<K, V> where
<K as ArrowPrimitiveType>::Native: RefUnwindSafe,
<V as ArrowPrimitiveType>::Native: RefUnwindSafe,
impl<K, V> Send for PrimitiveDictionaryBuilder<K, V>
impl<K, V> Sync for PrimitiveDictionaryBuilder<K, V>
impl<K, V> Unpin for PrimitiveDictionaryBuilder<K, V> where
<K as ArrowPrimitiveType>::Native: Unpin,
<V as ArrowPrimitiveType>::Native: Unpin,
impl<K, V> UnwindSafe for PrimitiveDictionaryBuilder<K, V> where
<K as ArrowPrimitiveType>::Native: UnwindSafe,
<V as ArrowPrimitiveType>::Native: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more