Module index_map

Trivially-copyable, easily comparable typed indices, and an IndexMap to contain them.

Examples

// first, create a new MapIndex type (this ensures type safety)
make_index! {
    Number
}

// then, create a map with that type
let mut numbers: IndexMap<Number, i32> = IndexMap::new();
let first = numbers.insert(1);
let second = numbers.insert(2);
let third = numbers.insert(3);

// You can access elements immutably with `get`
assert_eq!(Some(&3), numbers.get(third));
assert_eq!(Some(&2), numbers.get(second));
// or by indexing
assert_eq!(1, numbers[first]);

// Or mutably
*numbers.get_mut(first).unwrap() = 100000;

assert_eq!(Some(&100000), numbers.get(first));

Macros

make_index

Creates newtype indices over usize for use as IndexMap keys.

Structs

IndexMap

It’s an array. Lmao.

Traits

MapIndex

An index into a IndexMap. For full type-safety, there should be a unique MapIndex for each IndexMap.