aboutsummaryrefslogtreecommitdiff
path: root/src/di_container/blocking/binding/when_configurator.rs
diff options
context:
space:
mode:
authorHampusM <hampus@hampusmat.com>2023-09-19 20:37:28 +0200
committerHampusM <hampus@hampusmat.com>2023-09-19 21:32:32 +0200
commit862453174dc15e5184a4f86bb14f203ccef94de6 (patch)
tree900cb5e7f93735b5f81b3cbc0c4934688a4307ce /src/di_container/blocking/binding/when_configurator.rs
parent4fd0d6b4951b08a20d5378bca75561109dc6d036 (diff)
docs: add examples to DI container & related functions
Diffstat (limited to 'src/di_container/blocking/binding/when_configurator.rs')
-rw-r--r--src/di_container/blocking/binding/when_configurator.rs28
1 files changed, 28 insertions, 0 deletions
diff --git a/src/di_container/blocking/binding/when_configurator.rs b/src/di_container/blocking/binding/when_configurator.rs
index 2a1af2c..d23d213 100644
--- a/src/di_container/blocking/binding/when_configurator.rs
+++ b/src/di_container/blocking/binding/when_configurator.rs
@@ -34,6 +34,34 @@ where
///
/// # Errors
/// Will return Err if no binding for the interface already exists.
+ ///
+ /// # Examples
+ /// ```
+ /// # use syrette::{DIContainer, injectable};
+ /// #
+ /// # struct Kitten {}
+ /// #
+ /// # #[injectable]
+ /// # impl Kitten
+ /// # {
+ /// # fn new() -> Self
+ /// # {
+ /// # Self {}
+ /// # }
+ /// # }
+ /// #
+ /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
+ /// let mut di_container = DIContainer::new();
+ ///
+ /// di_container
+ /// .bind::<Kitten>()
+ /// .to::<Kitten>()?
+ /// .in_transient_scope()
+ /// .when_named("Billy")?;
+ /// #
+ /// # Ok(())
+ /// # }
+ /// ```
pub fn when_named(
self,
name: &'static str,