[Merged by Bors] - Improve EntityMap API

crates/bevy_ecs/src/entity/map_entities.rs

@@ -23,36 +23,57 @@ pub trait MapEntities {
     fn map_entities(&mut self, entity_map: &EntityMap) -> Result<(), MapEntitiesError>;
 }
 
+/// A hash map adapter for mapping entities.
 #[derive(Default, Debug)]
 pub struct EntityMap {
     map: HashMap<Entity, Entity>,
 }
 
 impl EntityMap {
-    pub fn insert(&mut self, from: Entity, to: Entity) {
-        self.map.insert(from, to);
+    /// Inserts an entities pair into the map.
+    ///
+    /// If the map did not have `from` present, [`None`] is returned.
+    ///
+    /// If the map did have `from` present, the value is updated, and the old value is returned.
+    pub fn insert(&mut self, from: Entity, to: Entity) -> Option<Entity> {
+        self.map.insert(from, to)
     }
 
-    pub fn remove(&mut self, entity: Entity) {
-        self.map.remove(&entity);
+    /// Removes an `entity` from the map, returning the mapped value of it if the `entity` was previously in the map.
+    pub fn remove(&mut self, entity: Entity) -> Option<Entity> {
+        self.map.remove(&entity)
     }
 
+    /// Gets the given entity's corresponding entry in the map for in-place manipulation.
     pub fn entry(&mut self, entity: Entity) -> Entry<'_, Entity, Entity> {
         self.map.entry(entity)
     }
 
+    /// Returns the corresponding mapped entity.
     pub fn get(&self, entity: Entity) -> Result<Entity, MapEntitiesError> {
         self.map
             .get(&entity)
             .cloned()
             .ok_or(MapEntitiesError::EntityNotFound(entity))
     }
 
+    /// An iterator visiting all keys in arbitrary order.
     pub fn keys(&self) -> impl Iterator<Item = Entity> + '_ {
         self.map.keys().cloned()
     }
 
+    /// An iterator visiting all values in arbitrary order.
     pub fn values(&self) -> impl Iterator<Item = Entity> + '_ {
         self.map.values().cloned()
     }
+
+    /// Returns the number of elements in the map.
+    pub fn len(&self) -> usize {
+        self.map.len()
+    }
+
+    /// Returns true if the map contains no elements.
+    pub fn is_empty(&self) -> bool {
+        self.map.is_empty()
+    }
 }