Map

Struct Map 

Source
pub struct Map<K, V, const SORTED: bool = false>(/* private fields */);
Expand description

Wrapper denoting an Arrow MapArray column with entries (K, V).

  • Keys are non-nullable by Arrow spec.
  • Values are non-nullable for Map<K, V, SORTED> and nullable for Map<K, Option<V>, SORTED>.
  • Column-level nullability is expressed with Option<Map<...>>.

Implementations§

Source§

impl<K, V, const SORTED: bool> Map<K, V, SORTED>

Source

pub fn new(entries: Vec<(K, V)>) -> Self

Construct a new map from a vector of (key, value) pairs.

Source

pub fn entries(&self) -> &Vec<(K, V)>

Borrow the underlying (key, value) entries.

Source

pub fn into_inner(self) -> Vec<(K, V)>

Consume and return the underlying (key, value) entries.

Trait Implementations§

Source§

impl<K, V, const SORTED: bool> ArrowBinding for Map<K, Option<V>, SORTED>

Source§

type Builder = MapBuilder<<K as ArrowBinding>::Builder, <V as ArrowBinding>::Builder>

Concrete Arrow builder type used for this Rust type.
Source§

type Array = MapArray

Concrete Arrow array type produced by finish.
Source§

fn data_type() -> DataType

The Arrow DataType corresponding to this Rust type.
Source§

fn new_builder(_capacity: usize) -> Self::Builder

Create a new builder with an optional capacity hint.
Source§

fn append_value(b: &mut Self::Builder, v: &Self)

Append a non-null value to the builder.
Source§

fn append_null(b: &mut Self::Builder)

Append a null to the builder.
Source§

fn finish(b: Self::Builder) -> Self::Array

Finish the builder and produce a typed Arrow array.
Source§

fn estimated_bytes_per_value() -> usize

Estimated bytes per value for variable-length types (String, Binary, etc.). Returns 0 for fixed-size types. Used to pre-allocate buffer space.
Source§

impl<K, V, const SORTED: bool> ArrowBinding for Map<K, V, SORTED>

Source§

type Builder = MapBuilder<<K as ArrowBinding>::Builder, <V as ArrowBinding>::Builder>

Concrete Arrow builder type used for this Rust type.
Source§

type Array = MapArray

Concrete Arrow array type produced by finish.
Source§

fn data_type() -> DataType

The Arrow DataType corresponding to this Rust type.
Source§

fn new_builder(_capacity: usize) -> Self::Builder

Create a new builder with an optional capacity hint.
Source§

fn append_value(b: &mut Self::Builder, v: &Self)

Append a non-null value to the builder.
Source§

fn append_null(b: &mut Self::Builder)

Append a null to the builder.
Source§

fn finish(b: Self::Builder) -> Self::Array

Finish the builder and produce a typed Arrow array.
Source§

fn estimated_bytes_per_value() -> usize

Estimated bytes per value for variable-length types (String, Binary, etc.). Returns 0 for fixed-size types. Used to pre-allocate buffer space.
Source§

impl<K, V, const SORTED: bool> ArrowBindingView for Map<K, Option<V>, SORTED>
where K: ArrowBinding + ArrowBindingView + 'static, V: ArrowBinding + ArrowBindingView + 'static,

Available on crate feature views only.
Source§

type Array = MapArray

The Arrow array type this view reads from.
Source§

type View<'a> = MapViewNullable<'a, K, V, SORTED>

The borrowed view type returned when accessing array elements. For example: &'a str for StringArray, i64 for Int64Array.
Source§

fn get_view( array: &Self::Array, index: usize, ) -> Result<Self::View<'_>, ViewAccessError>

Extract a view at the given index from the array. Read more
Source§

impl<K, V, const SORTED: bool> ArrowBindingView for Map<K, V, SORTED>
where K: ArrowBinding + ArrowBindingView + 'static, V: ArrowBinding + ArrowBindingView + 'static,

Available on crate feature views only.
Source§

type Array = MapArray

The Arrow array type this view reads from.
Source§

type View<'a> = MapView<'a, K, V, SORTED>

The borrowed view type returned when accessing array elements. For example: &'a str for StringArray, i64 for Int64Array.
Source§

fn get_view( array: &Self::Array, index: usize, ) -> Result<Self::View<'_>, ViewAccessError>

Extract a view at the given index from the array. Read more
Source§

impl<K: Clone, V: Clone, const SORTED: bool> Clone for Map<K, V, SORTED>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<K: Debug, V: Debug, const SORTED: bool> Debug for Map<K, V, SORTED>

Source§

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

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

impl<K, V, const SORTED: bool> From<Vec<(K, V)>> for Map<K, V, SORTED>

Source§

fn from(entries: Vec<(K, V)>) -> Self

Convert a vector of (key, value) pairs into a Map.

Source§

impl<K, V, const SORTED: bool> FromIterator<(K, V)> for Map<K, V, SORTED>

Source§

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Collect an iterator of (key, value) pairs into a Map.

Auto Trait Implementations§

§

impl<K, V, const SORTED: bool> Freeze for Map<K, V, SORTED>

§

impl<K, V, const SORTED: bool> RefUnwindSafe for Map<K, V, SORTED>

§

impl<K, V, const SORTED: bool> Send for Map<K, V, SORTED>
where K: Send, V: Send,

§

impl<K, V, const SORTED: bool> Sync for Map<K, V, SORTED>
where K: Sync, V: Sync,

§

impl<K, V, const SORTED: bool> Unpin for Map<K, V, SORTED>
where K: Unpin, V: Unpin,

§

impl<K, V, const SORTED: bool> UnwindSafe for Map<K, V, SORTED>
where K: UnwindSafe, V: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

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