Struct arrow_array::builder::PrimitiveDictionaryBuilder
source · pub struct PrimitiveDictionaryBuilder<K, V>where
K: ArrowPrimitiveType,
V: ArrowPrimitiveType,{ /* private fields */ }
Expand description
Builder for DictionaryArray
of PrimitiveArray
§Example:
let mut builder = PrimitiveDictionaryBuilder::<UInt8Type, UInt32Type>::new();
builder.append(12345678).unwrap();
builder.append_null();
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§
source§impl<K, V> PrimitiveDictionaryBuilder<K, V>where
K: ArrowPrimitiveType,
V: ArrowPrimitiveType,
impl<K, V> PrimitiveDictionaryBuilder<K, V>where
K: ArrowPrimitiveType,
V: ArrowPrimitiveType,
sourcepub fn new_from_empty_builders(
keys_builder: PrimitiveBuilder<K>,
values_builder: PrimitiveBuilder<V>,
) -> Self
pub fn new_from_empty_builders( keys_builder: PrimitiveBuilder<K>, values_builder: PrimitiveBuilder<V>, ) -> Self
Creates a new PrimitiveDictionaryBuilder
from the provided keys and values builders.
§Panics
This method panics if keys_builder
or values_builder
is not empty.
sourcepub unsafe fn new_from_builders(
keys_builder: PrimitiveBuilder<K>,
values_builder: PrimitiveBuilder<V>,
) -> Self
pub unsafe fn new_from_builders( keys_builder: PrimitiveBuilder<K>, values_builder: PrimitiveBuilder<V>, ) -> Self
Creates a new PrimitiveDictionaryBuilder
from existing PrimitiveBuilder
s of keys and values.
§Safety
caller must ensure that the passed in builders are valid for DictionaryArray.
sourcepub fn with_capacity(keys_capacity: usize, values_capacity: usize) -> Self
pub fn with_capacity(keys_capacity: usize, values_capacity: usize) -> Self
Creates a new PrimitiveDictionaryBuilder
with the provided capacities
keys_capacity
: the number of keys, i.e. length of array to build
values_capacity
: the number of distinct dictionary values, i.e. size of dictionary
source§impl<K, V> PrimitiveDictionaryBuilder<K, V>where
K: ArrowDictionaryKeyType,
V: ArrowPrimitiveType,
impl<K, V> PrimitiveDictionaryBuilder<K, V>where
K: ArrowDictionaryKeyType,
V: ArrowPrimitiveType,
sourcepub fn append(&mut self, value: V::Native) -> Result<K::Native, ArrowError>
pub fn append(&mut self, value: V::Native) -> Result<K::Native, ArrowError>
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.
sourcepub fn append_value(&mut self, value: V::Native)
pub fn append_value(&mut self, value: V::Native)
Infallibly append a value to this builder
§Panics
Panics if the resulting length of the dictionary values array would exceed T::Native::MAX
sourcepub fn append_null(&mut self)
pub fn append_null(&mut self)
Appends a null slot into the builder
sourcepub fn append_option(&mut self, value: Option<V::Native>)
pub fn append_option(&mut self, value: Option<V::Native>)
Append an Option
value into the builder
§Panics
Panics if the resulting length of the dictionary values array would exceed T::Native::MAX
sourcepub fn finish(&mut self) -> DictionaryArray<K>
pub fn finish(&mut self) -> DictionaryArray<K>
Builds the DictionaryArray
and reset this builder.
sourcepub fn finish_cloned(&self) -> DictionaryArray<K>
pub fn finish_cloned(&self) -> DictionaryArray<K>
Builds the DictionaryArray
without resetting the builder.
sourcepub fn values_slice(&self) -> &[V::Native]
pub fn values_slice(&self) -> &[V::Native]
Returns the current dictionary values buffer as a slice
sourcepub fn values_slice_mut(&mut self) -> &mut [V::Native]
pub fn values_slice_mut(&mut self) -> &mut [V::Native]
Returns the current dictionary values buffer as a mutable slice
Trait Implementations§
source§impl<K, V> ArrayBuilder for PrimitiveDictionaryBuilder<K, V>where
K: ArrowDictionaryKeyType,
V: ArrowPrimitiveType,
impl<K, V> ArrayBuilder for PrimitiveDictionaryBuilder<K, V>where
K: ArrowDictionaryKeyType,
V: ArrowPrimitiveType,
source§fn 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.
source§fn finish_cloned(&self) -> ArrayRef
fn finish_cloned(&self) -> ArrayRef
Builds the array without resetting the builder.
source§impl<K, V> Debug for PrimitiveDictionaryBuilder<K, V>
impl<K, V> Debug for PrimitiveDictionaryBuilder<K, V>
source§impl<K, V> Default for PrimitiveDictionaryBuilder<K, V>where
K: ArrowPrimitiveType,
V: ArrowPrimitiveType,
impl<K, V> Default for PrimitiveDictionaryBuilder<K, V>where
K: ArrowPrimitiveType,
V: ArrowPrimitiveType,
source§impl<K: ArrowDictionaryKeyType, P: ArrowPrimitiveType> Extend<Option<<P as ArrowPrimitiveType>::Native>> for PrimitiveDictionaryBuilder<K, P>
impl<K: ArrowDictionaryKeyType, P: ArrowPrimitiveType> Extend<Option<<P as ArrowPrimitiveType>::Native>> for PrimitiveDictionaryBuilder<K, P>
source§fn extend<T: IntoIterator<Item = Option<P::Native>>>(&mut self, iter: T)
fn extend<T: IntoIterator<Item = Option<P::Native>>>(&mut self, iter: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)