Struct Map

pub struct Map<V> { /* private fields */ }

A map with a fixed capacity and usize as keys.

Implementations

impl<V: Clone> Map<V>

pub fn with_capacity(cap: usize) -> Self

Make it.

Panics

May panic if out of memory.

pub fn with_capacity_none(cap: usize) -> Self

Make it and prepare all keys.

This is a more expensive operation that with_capacity, because it has to go through all keys and fill them up with None.

Panics

May panic if out of memory.

pub fn with_capacity_some(cap: usize, v: V) -> Self

Make it and prepare all keys with some value set.

This is a more expensive operation that with_capacity, because it has to go through all keys and fill them up with Some.

Panics

May panic if out of memory.

pub const fn capacity(&self) -> usize

Return capacity.

impl<V: Clone> Map<V>

pub const fn iter(&self) -> Iter<'_, V>

Make an iterator over all items.

Panics

It may panic in debug mode, if the Map is not initialized.

pub const fn iter_mut(&self) -> IterMut<'_, V>

Make a mutable iterator over all items.

For example:

use emap::Map;
let mut m: Map<String> = Map::with_capacity_none(16);
m.insert(0, "Jeff".to_string());
m.insert(1, "Lebowski".to_string());
for (_, v) in m.iter_mut() {
  *v = v.to_lowercase();
}

The keys are not mutable, only the values, for obvious reasons.

Panics

It may panic in debug mode, if the Map is not initialized.

pub const fn into_iter(&self) -> IntoIter<V>

Make an iterator over all items.

Panics

It may panic in debug mode, if the Map is not initialized.

impl<V: Clone> Map<V>

pub const fn keys(&self) -> Keys<V>

Make an iterator over all keys.

Panics

It may panic in debug mode, if the Map is not initialized.

impl<V: Clone> Map<V>

pub fn is_empty(&self) -> bool

Is it empty?

pub fn len(&self) -> usize

Return the total number of items inside.

Panics

It may panic in debug mode, if the Map is not initialized.

pub fn contains_key(&self, k: usize) -> bool

Does the map contain this key?

Panics

It may panic if you attempt to refer to they key that is outside of the boundary of this map. It will not return None, it will panic. However, in “release” mode it will not panic, but will lead to undefined behavior.

pub fn remove(&mut self, k: usize)

Remove by key.

Panics

It may panic if you attempt to refer to they key that is outside of the boundary of this map. It will not return None, it will panic. However, in “release” mode it will not panic, but will lead to undefined behavior.

pub fn push(&mut self, v: V) -> usize

Push to the rightmost position and return the key.

pub fn insert(&mut self, k: usize, v: V)

Insert a single pair into the map.

Panics

It may panic if you attempt to refer to they key that is outside of the boundary of this map. It will not return None, it will panic. However, in “release” mode it will not panic, but will lead to undefined behavior.

pub fn get(&self, k: usize) -> Option<&V>

Get a reference to a single value.

Panics

It may panic if you attempt to refer to they key that is outside of the boundary of this map. It will not return None, it will panic. However, in “release” mode it will not panic, but will lead to undefined behavior.

pub fn get_mut(&mut self, k: usize) -> Option<&mut V>

Get a mutable reference to a single value.

Panics

It may panic if you attempt to refer to they key that is outside of the boundary of this map. It will not return None, it will panic. However, in “release” mode it will not panic, but will lead to undefined behavior.

pub fn clear(&mut self)

Remove all items from it, but keep the space intact for future use.

pub fn retain<F: Fn(&usize, &V) -> bool>(&mut self, f: F)

Retains only the elements specified by the predicate.

Panics

It may panic in debug mode, if the Map is not initialized.

impl<V: Clone> Map<V>

pub fn next_key(&self) -> usize

Get the next key available for insertion.

Panics

If no more keys left.

pub fn next_key_gte(&self, k: usize) -> usize

Get the next key available for insertion, which is “greater or equal” than the number provided.

Panics

If no more keys left.

It may also panic in “debug” mode if the Map is not initialized.

impl<V: Clone> Map<V>

pub const fn values(&self) -> Values<'_, V>

Make an iterator over all values.

Panics

It may panic in debug mode, if the Map is not initialized.

pub const fn into_values(&self) -> IntoValues<V>

Make an into-iterator over all items.

Panics

It may panic in debug mode, if the Map is not initialized.

Trait Implementations

impl<V: Clone> Clone for Map<V>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Clone + Display> Debug for Map<V>

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

Formats the value using the given formatter.

impl<V: Clone + Display> Display for Map<V>

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

Formats the value using the given formatter.

impl<V> Drop for Map<V>

fn drop(&mut self)

Executes the destructor for this type.

impl<V: Clone> Index<usize> for Map<V>

type Output = V

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<V: Clone> IndexMut<usize> for Map<V>

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

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

impl<'a, V: Copy> IntoIterator for &'a Map<V>

type Item = (usize, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.