diff options
Diffstat (limited to 'engine-ecs/src/sole.rs')
| -rw-r--r-- | engine-ecs/src/sole.rs | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/engine-ecs/src/sole.rs b/engine-ecs/src/sole.rs index 1e287d3..4047b48 100644 --- a/engine-ecs/src/sole.rs +++ b/engine-ecs/src/sole.rs @@ -61,7 +61,10 @@ impl<'world, SoleT> Single<'world, SoleT> where SoleT: Sole, { - /// Returns a reference to `SoleT` if it exists. If not, returns `Err`. + /// Returns a reference to `SoleT`. + /// + /// # Errors + /// Returns `Err` if the sole does not exist. pub fn get(&self) -> Result<&SoleT, DoesNotExistError> { self.sole @@ -69,7 +72,10 @@ where .ok_or_else(|| DoesNotExistError { name: type_name::<SoleT>() }) } - /// Returns a mutable reference to `SoleT` if it exists. If not, returns `Err`. + /// Returns a mutable reference to `SoleT`. + /// + /// # Errors + /// Returns `Err` if the sole does not exist. pub fn get_mut(&mut self) -> Result<&mut SoleT, DoesNotExistError> { self.sole |
