More documentation.

src/static_data/libraries/ability_library.rs

@@ -1,35 +1,31 @@
-use hashbrown::HashMap;
+use indexmap::IndexMap;
 
 use crate::static_data::Ability;
 use crate::static_data::DataLibrary;
 use crate::StringKey;
 
+/// A storage for all abilities that can be used in this data library.
 #[derive(Debug)]
 pub struct AbilityLibrary {
-    map: HashMap<StringKey, Box<Ability>>,
-    list: Vec<StringKey>,
+    /// The underlying map for the library.
+    map: IndexMap<StringKey, Box<Ability>>,
 }
 
 impl AbilityLibrary {
+    /// Instantiates a new ability library.
     pub fn new(capacity: usize) -> AbilityLibrary {
         AbilityLibrary {
-            map: HashMap::with_capacity(capacity),
-            list: Vec::with_capacity(capacity),
+            map: IndexMap::with_capacity(capacity),
         }
     }
 }
 
 impl DataLibrary<'_, Box<Ability>> for AbilityLibrary {
-    fn map(&self) -> &HashMap<StringKey, Box<Ability>> {
+    fn map(&self) -> &IndexMap<StringKey, Box<Ability>> {
         &self.map
     }
-
-    fn list_values(&self) -> &Vec<StringKey> {
-        &self.list
-    }
-
-    fn get_modify(&mut self) -> (&mut HashMap<StringKey, Box<Ability>>, &mut Vec<StringKey>) {
-        (&mut self.map, &mut self.list)
+    fn get_modify(&mut self) -> &mut IndexMap<StringKey, Box<Ability>> {
+        &mut self.map
     }
 }
 
@@ -62,17 +58,8 @@ pub mod tests {
     #[test]
     fn get_ability_library_direct_map_access() {
         let lib = build();
-        let map = lib.map();
-        let ability = map.get(&"test_ability".into());
+        let ability = lib.get(&"test_ability".into());
         assert!(ability.is_some());
         assert_eq!(ability.unwrap().name(), &"test_ability".into());
     }
-
-    #[test]
-    fn get_ability_library_direct_list_access() {
-        let lib = build();
-        let list = lib.list_values();
-        assert_eq!(list.len(), 1);
-        assert!(list.contains(&StringKey::new("test_ability")));
-    }
 }