aboutsummaryrefslogtreecommitdiff
path: root/src/di_container/asynchronous/binding/scope_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/asynchronous/binding/scope_configurator.rs
parent4fd0d6b4951b08a20d5378bca75561109dc6d036 (diff)
docs: add examples to DI container & related functions
Diffstat (limited to 'src/di_container/asynchronous/binding/scope_configurator.rs')
-rw-r--r--src/di_container/asynchronous/binding/scope_configurator.rs91
1 files changed, 91 insertions, 0 deletions
diff --git a/src/di_container/asynchronous/binding/scope_configurator.rs b/src/di_container/asynchronous/binding/scope_configurator.rs
index f079234..b63e644 100644
--- a/src/di_container/asynchronous/binding/scope_configurator.rs
+++ b/src/di_container/asynchronous/binding/scope_configurator.rs
@@ -47,6 +47,36 @@ where
/// Configures the binding to be in a transient scope.
///
/// This is the default.
+ ///
+ /// # Examples
+ /// ```
+ /// # use syrette::{AsyncDIContainer, injectable};
+ /// #
+ /// # struct Authenticator {}
+ /// #
+ /// # #[injectable(async = true)]
+ /// # impl Authenticator
+ /// # {
+ /// # fn new() -> Self
+ /// # {
+ /// # Self {}
+ /// # }
+ /// # }
+ /// #
+ /// # #[tokio::main]
+ /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
+ /// let mut di_container = AsyncDIContainer::new();
+ ///
+ /// di_container
+ /// .bind::<Authenticator>()
+ /// .to::<Authenticator>()
+ /// .await?
+ /// .in_transient_scope()
+ /// .await;
+ /// #
+ /// # Ok(())
+ /// # }
+ /// ```
pub async fn in_transient_scope(
self,
) -> AsyncBindingWhenConfigurator<'di_container, Interface>
@@ -60,6 +90,67 @@ where
///
/// # Errors
/// Will return Err if resolving the implementation fails.
+ ///
+ /// # Examples
+ /// ```
+ /// # use std::sync::atomic::{AtomicBool, Ordering};
+ /// # use syrette::{AsyncDIContainer, injectable};
+ /// #
+ /// # struct AudioManager
+ /// # {
+ /// # is_sound_playing: AtomicBool
+ /// # }
+ /// #
+ /// # #[injectable(async = true)]
+ /// # impl AudioManager
+ /// # {
+ /// # fn new() -> Self
+ /// # {
+ /// # Self { is_sound_playing: AtomicBool::new(false) }
+ /// # }
+ /// #
+ /// # fn play_long_sound(&self)
+ /// # {
+ /// # self.is_sound_playing.store(true, Ordering::Relaxed);
+ /// # }
+ /// #
+ /// # fn is_sound_playing(&self) -> bool
+ /// # {
+ /// # self.is_sound_playing.load(Ordering::Relaxed)
+ /// # }
+ /// #
+ /// # }
+ /// #
+ /// # #[tokio::main]
+ /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
+ /// let mut di_container = AsyncDIContainer::new();
+ ///
+ /// di_container
+ /// .bind::<AudioManager>()
+ /// .to::<AudioManager>()
+ /// .await?
+ /// .in_singleton_scope()
+ /// .await;
+ ///
+ /// {
+ /// let audio_manager = di_container
+ /// .get::<AudioManager>()
+ /// .await?
+ /// .threadsafe_singleton()?;
+ ///
+ /// audio_manager.play_long_sound();
+ /// }
+ ///
+ /// let audio_manager = di_container
+ /// .get::<AudioManager>()
+ /// .await?
+ /// .threadsafe_singleton()?;
+ ///
+ /// assert!(audio_manager.is_sound_playing());
+ /// #
+ /// # Ok(())
+ /// # }
+ /// ```
pub async fn in_singleton_scope(
self,
) -> Result<