Struct hirofa_utils::auto_id_map::AutoIdMap

pub struct AutoIdMap<T> {
    pub map: HashMap<usize, T>,
    /* private fields */
}

AutoIdMap is a wrapper around HashMap which automatically creates a unique id for it’s entries

Example

use hirofa_utils::auto_id_map::AutoIdMap;
let mut map = AutoIdMap::new();
let id1 = map.insert("hi");
let id2 = map.insert("hi2");
assert_ne!(id1, id2);
assert_eq!(map.len(), 2);
let s1 = map.remove(&id1);
assert_eq!(s1, "hi");
assert_eq!(map.len(), 1);

Fields

map: HashMap<usize, T>

Implementations

impl<T> AutoIdMap<T>

pub fn new() -> AutoIdMap<T>

create a new instance of the AutoIdMap

pub fn new_with_max_size(max_size: usize) -> AutoIdMap<T>

pub fn foreach_value<F: Fn(&T)>(&self, f: F)

pub fn foreach_value_mut<F: Fn(&mut T)>(&mut self, f: F)

pub fn foreach<F: Fn(&usize, &T)>(&self, f: F)

pub fn clear(&mut self)

pub fn remove_values<F: Fn(&T) -> bool>(&mut self, f: F) -> Vec<T>

pub fn contains_value<F: Fn(&T) -> bool>(&self, f: F) -> bool

pub fn insert(&mut self, elem: T) -> usize

insert an element and return the new id

pub fn try_insert(&mut self, elem: T) -> Result<usize, &str>

insert an element and return the new id

pub fn replace(&mut self, id: &usize, elem: T)

replace an element, this will panic if you pass an id that is not present

pub fn get(&self, id: &usize) -> Option<&T>

get an element based on it’s id

pub fn get_mut(&mut self, id: &usize) -> Option<&mut T>

get an element based on it’s id

pub fn remove(&mut self, id: &usize) -> T

remove an element based on its id

pub fn remove_opt(&mut self, id: &usize) -> Option<T>

remove an element based on its id

pub fn len(&self) -> usize

get the size of the map

pub fn is_empty(&self) -> bool

see if map is empty

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

check if a map contains a certain id

Trait Implementations

impl<T> Default for AutoIdMap<T>

fn default() -> Self

Returns the “default value” for a type.