README.md
1# enum-map
2
3A library providing enum map providing type safe enum array. It is
4implemented using regular Rust arrays, so using them is as fast
5as using regular Rust arrays.
6
7If you are using Rust 1.35 or older, you may want to use enum-map 0.5 instead,
8as enum-map 0.6 requires Rust 1.36.
9
10## Examples
11
12```rust
13#[macro_use]
14extern crate enum_map;
15
16use enum_map::EnumMap;
17
18#[derive(Debug, Enum)]
19enum Example {
20 A,
21 B,
22 C,
23}
24
25fn main() {
26 let mut map = enum_map! {
27 Example::A => 1,
28 Example::B => 2,
29 Example::C => 3,
30 };
31 map[Example::C] = 4;
32
33 assert_eq!(map[Example::A], 1);
34
35 for (key, &value) in &map {
36 println!("{:?} has {} as value.", key, value);
37 }
38}
39```
40