# Struct ordered_multimap::list_ordered_multimap::KeyValues

source · [−]

    pub struct KeyValues<'map, Key, Value, State = RandomState> { /* private fields */ }

Expand description

An iterator that yields immutable references to all keys and their value iterators. The order of the yielded items is always in the order the keys were first inserted.

## Trait Implementations

source

### impl<'map, Key, Value, State> Clone for KeyValues<'map, Key, Value, State>

source

#### fn clone(&self) -> KeyValues<'map, Key, Value, State>ⓘNotable traits for KeyValues<'map, Key, Value, State>`impl<'map, Key, Value, State> Iterator for KeyValues<'map, Key, Value, State> where
Key: Eq + Hash,
State: BuildHasher, type Item = (&'map Key, EntryValues<'map, Key, Value>);`

Returns a copy 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<Key, Value, State> Debug for KeyValues<'_, Key, Value, State> where
Key: Debug + Eq + Hash,
State: BuildHasher,
Value: Debug,

source

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

Formats the value using the given formatter. Read more

source

### impl<Key, Value, State> DoubleEndedIterator for KeyValues<'_, Key, Value, State> where
Key: Eq + Hash,
State: BuildHasher,

source

#### fn next_back(&mut self) -> Option<Self::Item>

Removes and returns an element from the end of the iterator. Read more

source

#### fn advance_back_by(&mut self, n: usize) -> Result<(), usize>

🔬 This is a nightly-only experimental API. (`iter_advance_by`)

Advances the iterator from the back by `n` elements. Read more

1.37.0 · source

#### fn nth_back(&mut self, n: usize) -> Option<Self::Item>

Returns the `n`th element from the end of the iterator. Read more

1.27.0 · source

#### fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> R where
F: FnMut(B, Self::Item) -> R,
R: Try<Output = B>,

This is the reverse version of `Iterator::try_fold()`: it takes elements starting from the back of the iterator. Read more

1.27.0 · source

#### fn rfold<B, F>(self, init: B, f: F) -> B where
F: FnMut(B, Self::Item) -> B,

An iterator method that reduces the iterator’s elements to a single, final value, starting from the back. Read more

1.27.0 · source

#### fn rfind<P>(&mut self, predicate: P) -> Option<Self::Item> where
P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator from the back that satisfies a predicate. Read more

source

### impl<Key, Value, State> ExactSizeIterator for KeyValues<'_, Key, Value, State> where
Key: Eq + Hash,
State: BuildHasher,

1.0.0 · source

#### fn len(&self) -> usize

Returns the exact remaining length of the iterator. Read more

source

#### fn is_empty(&self) -> bool

🔬 This is a nightly-only experimental API. (`exact_size_is_empty`)

Returns `true` if the iterator is empty. Read more

source

### impl<'map, Key, Value, State> Iterator for KeyValues<'map, Key, Value, State> where
Key: Eq + Hash,
State: BuildHasher,

#### type Item = (&'map Key, EntryValues<'map, Key, Value>)

The type of the elements being iterated over.

source

#### fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value. Read more

source

#### fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator. Read more

source

#### fn next_chunk<const N: usize>(
&mut self
) -> Result<[Self::Item ; N], IntoIter<Self::Item, N>>

🔬 This is a nightly-only experimental API. (`iter_next_chunk`)

Advances the iterator and returns an array containing the next `N` values. Read more

1.0.0 · source

#### fn count(self) -> usize

Consumes the iterator, counting the number of iterations and returning it. Read more

1.0.0 · source

#### fn last(self) -> Option<Self::Item>

Consumes the iterator, returning the last element. Read more

source

#### fn advance_by(&mut self, n: usize) -> Result<(), usize>

🔬 This is a nightly-only experimental API. (`iter_advance_by`)

Advances the iterator by `n` elements. Read more

1.0.0 · source

#### fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the `n`th element of the iterator. Read more

1.28.0 · source

#### fn step_by(self, step: usize) -> StepBy<Self>

Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more

1.0.0 · source

#### fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new iterator over both in sequence. Read more

1.0.0 · source

#### fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator,

‘Zips up’ two iterators into a single iterator of pairs. Read more

source

#### fn intersperse(self, separator: Self::Item) -> Intersperse<Self> where
Self::Item: Clone,

🔬 This is a nightly-only experimental API. (`iter_intersperse`)

Creates a new iterator which places a copy of `separator` between adjacent items of the original iterator. Read more

source

#### fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G> where
G: FnMut() -> Self::Item,

🔬 This is a nightly-only experimental API. (`iter_intersperse`)

Creates a new iterator which places an item generated by `separator` between adjacent items of the original iterator. Read more

1.0.0 · source

#### fn map<B, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> B,

Takes a closure and creates an iterator which calls that closure on each element. Read more

1.21.0 · source

#### fn for_each<F>(self, f: F) where
F: FnMut(Self::Item),

Calls a closure on each element of an iterator. Read more

1.0.0 · source

#### fn filter<P>(self, predicate: P) -> Filter<Self, P> where
P: FnMut(&Self::Item) -> bool,

Creates an iterator which uses a closure to determine if an element should be yielded. Read more

1.0.0 · source

#### fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both filters and maps. Read more

1.0.0 · source

#### fn enumerate(self) -> Enumerate<Self>

Creates an iterator which gives the current iteration count as well as the next value. Read more

1.0.0 · source

#### fn peekable(self) -> Peekable<Self>

Creates an iterator which can use the `peek` and `peek_mut` methods to look at the next element of the iterator without consuming it. See their documentation for more information. Read more

1.0.0 · source

#### fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,

Creates an iterator that `skip`s elements based on a predicate. Read more

1.0.0 · source

#### fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,

Creates an iterator that yields elements based on a predicate. Read more

1.57.0 · source

#### fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P> where
P: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both yields elements based on a predicate and maps. Read more

1.0.0 · source

#### fn skip(self, n: usize) -> Skip<Self>

Creates an iterator that skips the first `n` elements. Read more

1.0.0 · source

#### fn take(self, n: usize) -> Take<Self>

Creates an iterator that yields the first `n` elements, or fewer if the underlying iterator ends sooner. Read more

1.0.0 · source

#### fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
F: FnMut(&mut St, Self::Item) -> Option<B>,

An iterator adapter similar to `fold` that holds internal state and produces a new iterator. Read more

1.0.0 · source

#### fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
U: IntoIterator,
F: FnMut(Self::Item) -> U,

Creates an iterator that works like map, but flattens nested structure. Read more

1.29.0 · source

#### fn flatten(self) -> Flatten<Self> where
Self::Item: IntoIterator,

Creates an iterator that flattens nested structure. Read more

1.0.0 · source

#### fn fuse(self) -> Fuse<Self>

Creates an iterator which ends after the first `None`. Read more

1.0.0 · source

#### fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item),

Does something with each element of an iterator, passing the value on. Read more

1.0.0 · source

#### fn by_ref(&mut self) -> &mut Self

Borrows an iterator, rather than consuming it. Read more

1.0.0 · source

#### fn collect<B>(self) -> B where
B: FromIterator<Self::Item>,

Transforms an iterator into a collection. Read more

source

#### fn try_collect<B>(
&mut self
) -> <<Self::Item as Try>::Residual as Residual<B>>::TryType where
B: FromIterator<<Self::Item as Try>::Output>,
Self::Item: Try,
<Self::Item as Try>::Residual: Residual<B>,

🔬 This is a nightly-only experimental API. (`iterator_try_collect`)

Fallibly transforms an iterator into a collection, short circuiting if a failure is encountered. Read more

source

#### fn collect_into<E>(self, collection: &mut E) -> &mut E where
E: Extend<Self::Item>,

🔬 This is a nightly-only experimental API. (`iter_collect_into`)

Collects all the items from an iterator into a collection. Read more

1.0.0 · source

#### fn partition<B, F>(self, f: F) -> (B, B) where
B: Default + Extend<Self::Item>,
F: FnMut(&Self::Item) -> bool,

Consumes an iterator, creating two collections from it. Read more

source

#### fn partition_in_place<'a, T, P>(self, predicate: P) -> usize where
T: 'a,
Self: DoubleEndedIterator<Item = &'a mut T>,
P: FnMut(&T) -> bool,

🔬 This is a nightly-only experimental API. (`iter_partition_in_place`)

Reorders the elements of this iterator in-place according to the given predicate, such that all those that return `true` precede all those that return `false`. Returns the number of `true` elements found. Read more

source

#### fn is_partitioned<P>(self, predicate: P) -> bool where
P: FnMut(Self::Item) -> bool,

🔬 This is a nightly-only experimental API. (`iter_is_partitioned`)

Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return `true` precede all those that return `false`. Read more

1.27.0 · source

#### fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R where
F: FnMut(B, Self::Item) -> R,
R: Try<Output = B>,

An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more

1.27.0 · source

#### fn try_for_each<F, R>(&mut self, f: F) -> R where
F: FnMut(Self::Item) -> R,
R: Try<Output = ()>,

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more

1.0.0 · source

#### fn fold<B, F>(self, init: B, f: F) -> B where
F: FnMut(B, Self::Item) -> B,

Folds every element into an accumulator by applying an operation, returning the final result. Read more

1.51.0 · source

#### fn reduce<F>(self, f: F) -> Option<Self::Item> where
F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing operation. Read more

source

#### fn try_reduce<F, R>(
&mut self,
f: F
) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType where
F: FnMut(Self::Item, Self::Item) -> R,
R: Try<Output = Self::Item>,
<R as Try>::Residual: Residual<Option<Self::Item>>,

🔬 This is a nightly-only experimental API. (`iterator_try_reduce`)

Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately. Read more

1.0.0 · source

#### fn all<F>(&mut self, f: F) -> bool where
F: FnMut(Self::Item) -> bool,

Tests if every element of the iterator matches a predicate. Read more

1.0.0 · source

#### fn any<F>(&mut self, f: F) -> bool where
F: FnMut(Self::Item) -> bool,

Tests if any element of the iterator matches a predicate. Read more

1.0.0 · source

#### fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where
P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator that satisfies a predicate. Read more

1.30.0 · source

#### fn find_map<B, F>(&mut self, f: F) -> Option<B> where
F: FnMut(Self::Item) -> Option<B>,

Applies function to the elements of iterator and returns the first non-none result. Read more

source

#### fn try_find<F, R>(
&mut self,
f: F
) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType where
F: FnMut(&Self::Item) -> R,
R: Try<Output = bool>,
<R as Try>::Residual: Residual<Option<Self::Item>>,

🔬 This is a nightly-only experimental API. (`try_find`)

Applies function to the elements of iterator and returns the first true result or the first error. Read more

1.0.0 · source

#### fn position<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,

Searches for an element in an iterator, returning its index. Read more

1.0.0 · source

#### fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,
Self: ExactSizeIterator + DoubleEndedIterator,

Searches for an element in an iterator from the right, returning its index. Read more

1.0.0 · source

#### fn max(self) -> Option<Self::Item> where
Self::Item: Ord,

Returns the maximum element of an iterator. Read more

1.0.0 · source

#### fn min(self) -> Option<Self::Item> where
Self::Item: Ord,

Returns the minimum element of an iterator. Read more

1.6.0 · source

#### fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where
B: Ord,
F: FnMut(&Self::Item) -> B,

Returns the element that gives the maximum value from the specified function. Read more

1.15.0 · source

#### fn max_by<F>(self, compare: F) -> Option<Self::Item> where
F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the maximum value with respect to the specified comparison function. Read more

1.6.0 · source

#### fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where
B: Ord,
F: FnMut(&Self::Item) -> B,

Returns the element that gives the minimum value from the specified function. Read more

1.15.0 · source

#### fn min_by<F>(self, compare: F) -> Option<Self::Item> where
F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the minimum value with respect to the specified comparison function. Read more

1.0.0 · source

#### fn rev(self) -> Rev<Self> where
Self: DoubleEndedIterator,

Reverses an iterator’s direction. Read more

1.0.0 · source

#### fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where
FromA: Default + Extend<A>,
FromB: Default + Extend<B>,
Self: Iterator<Item = (A, B)>,

Converts an iterator of pairs into a pair of containers. Read more

1.36.0 · source

#### fn copied<'a, T>(self) -> Copied<Self> where
T: 'a + Copy,
Self: Iterator<Item = &'a T>,

Creates an iterator which copies all of its elements. Read more

1.0.0 · source

#### fn cloned<'a, T>(self) -> Cloned<Self> where
T: 'a + Clone,
Self: Iterator<Item = &'a T>,

Creates an iterator which `clone`s all of its elements. Read more

1.0.0 · source

#### fn cycle(self) -> Cycle<Self> where
Self: Clone,

Repeats an iterator endlessly. Read more

1.11.0 · source

#### fn sum<S>(self) -> S where
S: Sum<Self::Item>,

Sums the elements of an iterator. Read more

1.11.0 · source

#### fn product<P>(self) -> P where
P: Product<Self::Item>,

Iterates over the entire iterator, multiplying all the elements Read more

1.5.0 · source

#### fn cmp<I>(self, other: I) -> Ordering where
I: IntoIterator<Item = Self::Item>,
Self::Item: Ord,

Lexicographically compares the elements of this `Iterator` with those of another. Read more

source

#### fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,

🔬 This is a nightly-only experimental API. (`iter_order_by`)

Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. Read more

1.5.0 · source

#### fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,

Lexicographically compares the elements of this `Iterator` with those of another. Read more

source

#### fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering> where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,

🔬 This is a nightly-only experimental API. (`iter_order_by`)

Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. Read more

1.5.0 · source

#### fn eq<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,

Determines if the elements of this `Iterator` are equal to those of another. Read more

source

#### fn eq_by<I, F>(self, other: I, eq: F) -> bool where
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,

🔬 This is a nightly-only experimental API. (`iter_order_by`)

Determines if the elements of this `Iterator` are equal to those of another with respect to the specified equality function. Read more

1.5.0 · source

#### fn ne<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,

Determines if the elements of this `Iterator` are unequal to those of another. Read more

1.5.0 · source

#### fn lt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,

Determines if the elements of this `Iterator` are lexicographically less than those of another. Read more

1.5.0 · source

#### fn le<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,

Determines if the elements of this `Iterator` are lexicographically less or equal to those of another. Read more

1.5.0 · source

#### fn gt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,

Determines if the elements of this `Iterator` are lexicographically greater than those of another. Read more

1.5.0 · source

#### fn ge<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,

Determines if the elements of this `Iterator` are lexicographically greater than or equal to those of another. Read more

source

#### fn is_sorted(self) -> bool where
Self::Item: PartialOrd<Self::Item>,

🔬 This is a nightly-only experimental API. (`is_sorted`)

Checks if the elements of this iterator are sorted. Read more

source

#### fn is_sorted_by<F>(self, compare: F) -> bool where
F: FnMut(&Self::Item, &Self::Item) -> Option<Ordering>,

🔬 This is a nightly-only experimental API. (`is_sorted`)

Checks if the elements of this iterator are sorted using the given comparator function. Read more

source

#### fn is_sorted_by_key<F, K>(self, f: F) -> bool where
F: FnMut(Self::Item) -> K,
K: PartialOrd<K>,

🔬 This is a nightly-only experimental API. (`is_sorted`)

Checks if the elements of this iterator are sorted using the given key extraction function. Read more

source

### impl<Key, Value, State> FusedIterator for KeyValues<'_, Key, Value, State> where
Key: Eq + Hash,
State: BuildHasher,

## Auto Trait Implementations

### impl<'map, Key, Value, State> RefUnwindSafe for KeyValues<'map, Key, Value, State> where
Key: RefUnwindSafe,
State: RefUnwindSafe,
Value: RefUnwindSafe,

### impl<'map, Key, Value, State> Send for KeyValues<'map, Key, Value, State> where
Key: Sync,
State: Sync,
Value: Sync,

### impl<'map, Key, Value, State> Sync for KeyValues<'map, Key, Value, State> where
Key: Sync,
State: Sync,
Value: Sync,

### impl<'map, Key, Value, State> Unpin for KeyValues<'map, Key, Value, State>

### impl<'map, Key, Value, State> UnwindSafe for KeyValues<'map, Key, Value, State> where
Key: RefUnwindSafe,
State: RefUnwindSafe,
Value: RefUnwindSafe,

## 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,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

### impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · 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<I> IntoIterator for I where
I: Iterator,

#### type Item = <I as Iterator>::Item

The type of the elements being iterated over.

#### type IntoIter = I

Which kind of iterator are we turning this into?

const: unstable · source

#### fn into_iter(self) -> I

Creates an iterator from a value. Read more

source

### impl<T> ToOwned for T where
T: Clone,

#### 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>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · 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>,

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.