enumoid 0.5.0

Enum Indexed Containers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

use enumoid::{EnumMap, EnumOptionMap, EnumSet, EnumVec};

use super::types::{Three, WideThree};

#[derive(Debug, PartialEq, serde::Serialize, serde::Deserialize, Default)]
struct TestData {
  value: i32,
  name: String,
}

#[test]
fn test_enum_map_round_trip() {
  let mut map = EnumMap::new();

  map[Three::A] = TestData {
    value: 42,
    name: "answer".to_string(),
  };
  map[Three::B] = TestData {
    value: 100,
    name: "century".to_string(),
  };
  map[Three::C] = TestData {
    value: -5,
    name: "negative".to_string(),
  };

  let ron_str = ron::to_string(&map).expect("Serialization failed");
  let deserialized: EnumMap<Three, TestData> =
    ron::from_str(&ron_str).expect("Deserialization failed");

  assert_eq!(map, deserialized);
  assert_eq!(map[Three::A], deserialized[Three::A]);
  assert_eq!(map[Three::B], deserialized[Three::B]);
  assert_eq!(map[Three::C], deserialized[Three::C]);
}

#[test]
fn test_enum_option_map_round_trip() {
  let mut map = EnumOptionMap::new();
  map.insert(
    Three::A,
    TestData {
      value: 42,
      name: "answer".to_string(),
    },
  );
  map.insert(
    Three::C,
    TestData {
      value: 999,
      name: "large".to_string(),
    },
  );

  let ron_str = ron::to_string(&map).expect("Serialization failed");
  let deserialized: EnumOptionMap<Three, TestData> =
    ron::from_str(&ron_str).expect("Deserialization failed");

  assert_eq!(map, deserialized);
}

#[test]
fn test_enum_option_map_empty_round_trip() {
  let map: EnumOptionMap<Three, i32> = EnumOptionMap::new();

  let ron_str = ron::to_string(&map).expect("Serialization failed");
  let deserialized: EnumOptionMap<Three, i32> =
    ron::from_str(&ron_str).expect("Deserialization failed");

  assert_eq!(map, deserialized);
}

#[test]
fn test_enum_option_map_wide_bitset_round_trip() {
  let mut map: EnumOptionMap<WideThree, TestData, usize> = EnumOptionMap::new();
  map.insert(
    WideThree::A,
    TestData {
      value: 42,
      name: "answer".to_string(),
    },
  );
  map.insert(
    WideThree::C,
    TestData {
      value: 999,
      name: "large".to_string(),
    },
  );

  let ron_str = ron::to_string(&map).expect("Serialization failed");
  let deserialized: EnumOptionMap<WideThree, TestData, usize> =
    ron::from_str(&ron_str).expect("Deserialization failed");

  assert_eq!(map, deserialized);
}

#[test]
fn test_enum_vec_round_trip() {
  let vec = EnumVec::from_iter([
    TestData {
      value: 10,
      name: "first".to_string(),
    },
    TestData {
      value: 20,
      name: "second".to_string(),
    },
    TestData {
      value: 30,
      name: "third".to_string(),
    },
  ]);

  let ron_str = ron::to_string(&vec).expect("Serialization failed");
  let deserialized: EnumVec<Three, TestData> =
    ron::from_str(&ron_str).expect("Deserialization failed");

  assert_eq!(vec, deserialized);
}

#[test]
fn test_enum_vec_empty_round_trip() {
  let vec: EnumVec<Three, i32> = EnumVec::new();

  let ron_str = ron::to_string(&vec).expect("Serialization failed");
  let deserialized: EnumVec<Three, i32> =
    ron::from_str(&ron_str).expect("Deserialization failed");

  assert_eq!(vec, deserialized);
}

#[test]
fn test_enum_set_round_trip() {
  let mut set = EnumSet::new();
  set.insert(Three::A);
  set.insert(Three::C);

  let ron_str = ron::to_string(&set).expect("Serialization failed");
  let deserialized: EnumSet<Three> =
    ron::from_str(&ron_str).expect("Deserialization failed");

  assert_eq!(set, deserialized);
}

#[test]
fn test_enum_set_empty_round_trip() {
  let set: EnumSet<Three> = EnumSet::new();

  let ron_str = ron::to_string(&set).expect("Serialization failed");
  let deserialized: EnumSet<Three> =
    ron::from_str(&ron_str).expect("Deserialization failed");

  assert_eq!(set, deserialized);
}

#[test]
fn test_enum_map_deserialize_partial_is_malformed() {
  // An EnumMap must be total, so a map missing keys fails the TryFrom in the
  // deserialiser and surfaces as a "malformed" error.
  let err = ron::from_str::<EnumMap<Three, i32>>("{A:1}")
    .expect_err("Expected deserialising a partial EnumMap to fail");
  assert!(
    err.to_string().contains("malformed"),
    "Expected a malformed error, got: {err}"
  );
}

#[test]
fn test_enum_vec_deserialize_gapped_is_malformed() {
  // An EnumVec must be a contiguous prefix, so a map with a gap fails the
  // TryFrom in the deserialiser and surfaces as a "malformed" error.
  let err = ron::from_str::<EnumVec<Three, i32>>("{A:1,C:3}")
    .expect_err("Expected deserialising a gapped EnumVec to fail");
  assert!(
    err.to_string().contains("malformed"),
    "Expected a malformed error, got: {err}"
  );
}