arrow_array::builder

Struct PrimitiveDictionaryBuilder

Source
pub struct PrimitiveDictionaryBuilder<K, V>{
    keys_builder: PrimitiveBuilder<K>,
    values_builder: PrimitiveBuilder<V>,
    map: HashMap<Value<V::Native>, usize>,
}
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]);

Fields§

§keys_builder: PrimitiveBuilder<K>§values_builder: PrimitiveBuilder<V>§map: HashMap<Value<V::Native>, usize>

Implementations§

Source§

impl<K, V> PrimitiveDictionaryBuilder<K, V>

Source

pub fn new() -> Self

Creates a new PrimitiveDictionaryBuilder.

Source

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.

Source

pub unsafe fn new_from_builders( keys_builder: PrimitiveBuilder<K>, values_builder: PrimitiveBuilder<V>, ) -> Self

Creates a new PrimitiveDictionaryBuilder from existing PrimitiveBuilders of keys and values.

§Safety

caller must ensure that the passed in builders are valid for DictionaryArray.

Source

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>

Source

fn get_or_insert_key( &mut self, value: V::Native, ) -> Result<K::Native, ArrowError>

Source

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.

Source

pub fn append_n( &mut self, value: V::Native, count: usize, ) -> Result<K::Native, ArrowError>

Append a value multiple times to the array. This is the same as append but allows to append the same value multiple times without doing multiple lookups.

Returns an error if the new index would overflow the key type.

Source

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

Source

pub fn append_values(&mut self, value: V::Native, count: usize)

Infallibly append a value to this builder repeatedly count times. This is the same as append_value but allows to append the same value multiple times without doing multiple lookups.

§Panics

Panics if the resulting length of the dictionary values array would exceed T::Native::MAX

Source

pub fn append_null(&mut self)

Appends a null slot into the builder

Source

pub fn append_nulls(&mut self, n: usize)

Append n null slots into the builder

Source

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

Source

pub fn append_options(&mut self, value: Option<V::Native>, count: usize)

Append an Option value into the builder repeatedly count times. This is the same as append_option but allows to append the same value multiple times without doing multiple lookups.

§Panics

Panics if the resulting length of the dictionary values array would exceed T::Native::MAX

Source

pub fn extend_dictionary( &mut self, dictionary: &TypedDictionaryArray<'_, K, PrimitiveArray<V>>, ) -> Result<(), ArrowError>

Extends builder with dictionary

This is the same as Self::extend but is faster as it translates the dictionary values once rather than doing a lookup for each item in the iterator

when dictionary values are null (the actual mapped values) the keys are null

Source

pub fn finish(&mut self) -> DictionaryArray<K>

Builds the DictionaryArray and reset this builder.

Source

pub fn finish_cloned(&self) -> DictionaryArray<K>

Builds the DictionaryArray without resetting the builder.

Source

pub fn values_slice(&self) -> &[V::Native]

Returns the current dictionary values buffer as a slice

Source

pub fn values_slice_mut(&mut self) -> &mut [V::Native]

Returns the current dictionary values buffer as a mutable slice

Source

pub fn validity_slice(&self) -> Option<&[u8]>

Returns the current null buffer as a slice

Trait Implementations§

Source§

impl<K, V> ArrayBuilder for PrimitiveDictionaryBuilder<K, V>

Source§

fn as_any(&self) -> &dyn Any

Returns the builder as an non-mutable Any reference.

Source§

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the builder as an mutable Any reference.

Source§

fn into_box_any(self: Box<Self>) -> Box<dyn Any>

Returns the boxed builder as a box of Any.

Source§

fn len(&self) -> usize

Returns the number of array slots in the builder

Source§

fn finish(&mut self) -> ArrayRef

Builds the array and reset this builder.

Source§

fn finish_cloned(&self) -> ArrayRef

Builds the array without resetting the builder.

Source§

fn is_empty(&self) -> bool

Returns whether number of array slots is zero
Source§

impl<K, V> Debug for PrimitiveDictionaryBuilder<K, V>

Source§

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

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

impl<K, V> Default for PrimitiveDictionaryBuilder<K, V>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

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)

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more

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> 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, 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.
§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,