Trait OrderedMapIterator

pub trait OrderedMapIterator: Iterator<Item = (Self::Key, Self::Val)> + Sized {
    type Key;
    type Val;

    // Provided methods
    fn inner_join_map<I>(self, map: I) -> InnerJoinMap<Self, I> 
       where I: OrderedMapIterator<Key = Self::Key> { ... }
    fn inner_join_set<I>(self, set: I) -> InnerJoinMapSet<Self, I> 
       where I: OrderedSetIterator<Item = Self::Key> { ... }
    fn outer_join<I>(self, other: I) -> OuterJoin<Self, I> 
       where I: OrderedMapIterator<Key = Self::Key> { ... }
}

Allows an iterator to do an inner join with another iterator to combine their values or filter based on their keys.

This trait is applied to an iterator over a map-like structure.

Required Associated Types

type Key

type Val

Provided Methods

fn inner_join_map<I>(self, map: I) -> InnerJoinMap<Self, I>

where I: OrderedMapIterator<Key = Self::Key>,

Joins two ordered maps together.

fn inner_join_set<I>(self, set: I) -> InnerJoinMapSet<Self, I>

where I: OrderedSetIterator<Item = Self::Key>,

Filters an ordered map with an ordered set.

fn outer_join<I>(self, other: I) -> OuterJoin<Self, I>

where I: OrderedMapIterator<Key = Self::Key>,

Joins an ordered iterator with another ordered iterator.

The new iterator will return a key-value pair for every key in either iterator. If a key is present in both iterators, they will be returned together (two values). If a value is in other but not self, it will be returned without the value in self. If the value is in self but not other, it will be returned without the value from other.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<'a, K: Ord, V> OrderedMapIterator for Iter<'a, K, V>

type Key = &'a K

type Val = &'a V

impl<'a, K: Ord, V> OrderedMapIterator for IterMut<'a, K, V>

type Key = &'a K

type Val = &'a mut V

impl<'a, V> OrderedMapIterator for Iter<'a, V>

type Key = usize

type Val = &'a V

impl<K: Ord, V> OrderedMapIterator for IntoIter<K, V>

type Key = K

type Val = V

Implementors

impl<A, B> OrderedMapIterator for InnerJoinMap<A, B>

where A: OrderedMapIterator, B: OrderedMapIterator<Key = A::Key>, A::Key: Ord,

type Key = <A as OrderedMapIterator>::Key

type Val = (<A as OrderedMapIterator>::Val, <B as OrderedMapIterator>::Val)

impl<A, B> OrderedMapIterator for InnerJoinMapSet<A, B>

where A: OrderedMapIterator, B: OrderedSetIterator<Item = A::Key>, A::Key: Ord,

type Key = <A as OrderedMapIterator>::Key

type Val = <A as OrderedMapIterator>::Val

impl<A, B> OrderedMapIterator for OuterJoin<A, B>

where A: OrderedMapIterator, B: OrderedMapIterator<Key = A::Key>, A::Key: Ord,

type Key = <A as OrderedMapIterator>::Key

type Val = (Option<<A as OrderedMapIterator>::Val>, Option<<B as OrderedMapIterator>::Val>)