Struct IndexMap

pub struct IndexMap<V>(/* private fields */);

Available on crate feature index-map only.

The main IndexMap data-structure type.

This map type uses a HashSet to store the underlying items. The underlying items are wrapped in a custom struct, hidden from the public API, to workaround Rust broken coherence and WTF other stupid similar rules.

Implementations

impl<V> IndexMap<V>

pub fn new() -> IndexMap<V>

Creates a new instance of an IndexMap.

pub fn len(&self) -> usize

Returns the number of items in this IndexMap.

pub fn is_empty(&self) -> bool

Returns true when this IndexMap is empty.

pub fn with_capacity(capacity: usize) -> IndexMap<V>

Creates a new instance of an IndexMap with a given capacity.

Arguments

• capacity: the capacity of the new IndexMap.

pub fn iter(&self) -> impl Iterator<Item = &V>

Returns an iterator over all elements contained in the map.

impl<V: Index> IndexMap<V>

pub fn insert(&mut self, value: V)

Inserts a new item in this IndexMap.

Arguments

• value: the value to be inserted.

returns: ()

pub fn get(&self, key: &V::Key) -> Option<&V>

where Item<V>: Borrow<V::Key>,

Gets an element stored in this IndexMap from its key.

Arguments

• key: the key of the element to look for.

Trait Implementations

impl<V: Clone> Clone for IndexMap<V>

fn clone(&self) -> IndexMap<V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: Debug> Debug for IndexMap<V>

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

Formats the value using the given formatter.

impl<V: Default> Default for IndexMap<V>

fn default() -> IndexMap<V>

Returns the “default value” for a type.

impl<'a, V: Index> Index<&'a <V as Index>::Key> for IndexMap<V>

where Item<V>: Borrow<V::Key>,

type Output = V

The returned type after indexing.

fn index(&self, index: &'a V::Key) -> &Self::Output

Performs the indexing (container[index]) operation.