Struct flat_map::flat_map::FlatMap

pub struct FlatMap<K, V> { /* fields omitted */ }

Methods

impl<K, V> FlatMap<K, V>

pub fn new() -> FlatMap<K, V>

pub fn with_capacity(capacity: usize) -> FlatMap<K, V>

pub fn capacity(&self) -> usize

Returns the number of elements the VecMap can hold without reallocating.

Examples

use flat_map::FlatMap;
let map: FlatMap<String, String> = FlatMap::with_capacity(10);
assert!(map.capacity() >= 10);

pub fn reserve(&mut self, additional: usize)

pub fn reserve_exact(&mut self, additional: usize)

pub fn shrink_to_fit(&mut self)

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Return true if the map contains no elements.

Examples

use flat_map::FlatMap;

let mut a = FlatMap::new();
assert!(a.is_empty());
a.insert("1", "a");
assert!(!a.is_empty());

pub fn iter<'r>(&'r self) -> Iter<'r, K, V>

pub fn iter_mut(&mut self) -> IterMut<K, V>

pub fn values_mut(&mut self) -> ValuesMut<K, V>

pub fn keys<'a>(&'a self) -> Keys<'a, K, V>

pub fn values<'a>(&'a self) -> Values<'a, K, V>

pub fn clear(&mut self)

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

pub fn retain<F>(&mut self, f: F) where
    F: FnMut(&K, &V) -> bool, 

impl<K: Ord, V> FlatMap<K, V>

pub fn insert(&mut self, key: K, v: V) -> Option<V>

pub fn append(&mut self, other: &mut Self)

pub fn split_off(&mut self, key: &K) -> Self

pub fn get<Q: ?Sized>(&self, q: &Q) -> Option<&V> where
    K: Borrow<Q>,
    Q: Ord, 

pub fn contains_key<Q: ?Sized>(&self, k: &Q) -> bool where
    K: Borrow<Q>,
    Q: Ord, 

pub fn get_mut<Q: ?Sized>(&mut self, q: &Q) -> Option<&mut V> where
    K: Borrow<Q>,
    Q: Ord, 

Return Option<&mut V>.

Example

use flat_map::FlatMap;

let mut m = FlatMap::new();
m.insert(1, "foo".to_string());
m.get_mut(&1).unwrap().push_str("bar");
assert_eq!("foobar", m.get_mut(&1).unwrap());

pub fn entry(&mut self, key: K) -> Entry<K, V>

pub fn remove<Q: ?Sized>(&mut self, q: &Q) -> Option<V> where
    K: Borrow<Q>,
    Q: Ord, 

Trait Implementations

impl<K: Clone, V: Clone> Clone for FlatMap<K, V>

fn clone(&self) -> FlatMap<K, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, V: Debug> Debug for FlatMap<K, V>

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

Formats the value using the given formatter.

impl<K: Default, V: Default> Default for FlatMap<K, V>

fn default() -> FlatMap<K, V>

Returns the "default value" for a type.

impl<K: Eq, V: Eq> Eq for FlatMap<K, V>

impl<'a, K: Ord + Copy, V: Copy> Extend<(&'a K, &'a V)> for FlatMap<K, V>

fn extend<I: IntoIterator<Item = (&'a K, &'a V)>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

impl<K: Ord, V> Extend<(K, V)> for FlatMap<K, V>

fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

impl<K: Ord, V> FromIterator<(K, V)> for FlatMap<K, V>

fn from_iter<T: IntoIterator<Item = (K, V)>>(iter: T) -> FlatMap<K, V>

Creates a value from an iterator.

impl<K: Hash, V: Hash> Hash for FlatMap<K, V>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'a, K: Ord, Q: ?Sized, V> Index<&'a Q> for FlatMap<K, V> where
    K: Borrow<Q>,
    Q: Ord, 

type Output = V

The returned type after indexing.

fn index(&self, key: &Q) -> &V

Performs the indexing (container[index]) operation.

impl<'a, K: Ord, Q: ?Sized, V> IndexMut<&'a Q> for FlatMap<K, V> where
    K: BorrowMut<Q>,
    Q: Ord, 

fn index_mut(&mut self, key: &Q) -> &mut V

Performs the mutable indexing (container[index]) operation.

impl<K, V> IntoIterator for FlatMap<K, V>

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<K, V>

Creates an iterator from a value.

impl<'a, K, V> IntoIterator for &'a FlatMap<K, V>

type Item = (&'a K, &'a V)

The type of the elements being iterated over.

type IntoIter = Iter<'a, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, K, V>

Creates an iterator from a value.

impl<'a, K, V> IntoIterator for &'a mut FlatMap<K, V>

type Item = (&'a K, &'a mut V)

The type of the elements being iterated over.

type IntoIter = IterMut<'a, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IterMut<'a, K, V>

Creates an iterator from a value.

impl<K: Ord, V: Ord> Ord for FlatMap<K, V>

fn cmp(&self, other: &FlatMap<K, V>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<K: PartialEq, V: PartialEq> PartialEq<FlatMap<K, V>> for FlatMap<K, V>

fn eq(&self, other: &FlatMap<K, V>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<K: PartialOrd, V: PartialOrd> PartialOrd<FlatMap<K, V>> for FlatMap<K, V>

fn partial_cmp(&self, other: &FlatMap<K, V>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.