diff options
author | HampusM <hampus@hampusmat.com> | 2022-07-31 17:27:33 +0200 |
---|---|---|
committer | HampusM <hampus@hampusmat.com> | 2022-08-01 15:26:43 +0200 |
commit | 7a6575220c6d9db564514bcbee552faa29095738 (patch) | |
tree | 19a97692bde26f994892830f0ff6f8cc23f611e1 /src/errors | |
parent | e20e442ee84918f8f06794ebb1a389a3a04bcdcc (diff) |
docs: add doc comments & deny missing docs
Diffstat (limited to 'src/errors')
-rw-r--r-- | src/errors/di_container.rs | 4 | ||||
-rw-r--r-- | src/errors/injectable.rs | 3 | ||||
-rw-r--r-- | src/errors/mod.rs | 2 |
3 files changed, 9 insertions, 0 deletions
diff --git a/src/errors/di_container.rs b/src/errors/di_container.rs index 3b8c717..127676f 100644 --- a/src/errors/di_container.rs +++ b/src/errors/di_container.rs @@ -1,8 +1,11 @@ +//! Error types for the DI container. + use std::fmt; use std::fmt::{Display, Formatter}; use error_stack::Context; +/// Error for when the DI container fails to do something. #[derive(Debug)] pub struct DIContainerError; @@ -16,6 +19,7 @@ impl Display for DIContainerError impl Context for DIContainerError {} +/// Error for when the binding builder fails to do something. #[derive(Debug)] pub struct BindingBuilderError; diff --git a/src/errors/injectable.rs b/src/errors/injectable.rs index 6b0cdc5..63afa11 100644 --- a/src/errors/injectable.rs +++ b/src/errors/injectable.rs @@ -1,8 +1,11 @@ +//! Error types for structs implementing Injectable. + use core::fmt; use std::fmt::{Display, Formatter}; use error_stack::Context; +/// Error for when a injectable struct fails to be resolved. #[derive(Debug)] pub struct ResolveError; diff --git a/src/errors/mod.rs b/src/errors/mod.rs index b0d50f0..5f628d6 100644 --- a/src/errors/mod.rs +++ b/src/errors/mod.rs @@ -1,2 +1,4 @@ +//! Error types for various components of the library. + pub mod di_container; pub mod injectable; |