diff options
Diffstat (limited to 'src/di_container/blocking')
| -rw-r--r-- | src/di_container/blocking/binding/scope_configurator.rs | 79 | ||||
| -rw-r--r-- | src/di_container/blocking/binding/when_configurator.rs | 28 | ||||
| -rw-r--r-- | src/di_container/blocking/mod.rs | 80 |
3 files changed, 187 insertions, 0 deletions
diff --git a/src/di_container/blocking/binding/scope_configurator.rs b/src/di_container/blocking/binding/scope_configurator.rs index 3d939ba..ee935a5 100644 --- a/src/di_container/blocking/binding/scope_configurator.rs +++ b/src/di_container/blocking/binding/scope_configurator.rs @@ -47,6 +47,33 @@ where /// Configures the binding to be in a transient scope. /// /// This is the default. + /// + /// # Examples + /// ``` + /// # use syrette::{DIContainer, injectable}; + /// # + /// # struct Authenticator {} + /// # + /// # #[injectable] + /// # impl Authenticator + /// # { + /// # fn new() -> Self + /// # { + /// # Self {} + /// # } + /// # } + /// # + /// # fn main() -> Result<(), Box<dyn std::error::Error>> { + /// let mut di_container = DIContainer::new(); + /// + /// di_container + /// .bind::<Authenticator>() + /// .to::<Authenticator>()? + /// .in_transient_scope(); + /// # + /// # Ok(()) + /// # } + /// ``` #[allow(clippy::must_use_candidate)] pub fn in_transient_scope(self) -> BindingWhenConfigurator<'di_container, Interface> { @@ -59,6 +86,58 @@ where /// /// # Errors /// Will return Err if resolving the implementation fails. + /// + /// # Examples + /// ``` + /// # use std::sync::atomic::{AtomicBool, Ordering}; + /// # use syrette::{DIContainer, injectable}; + /// # + /// # struct AudioManager + /// # { + /// # is_sound_playing: AtomicBool + /// # } + /// # + /// # #[injectable] + /// # 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) + /// # } + /// # + /// # } + /// # + /// # fn main() -> Result<(), Box<dyn std::error::Error>> { + /// let mut di_container = DIContainer::new(); + /// + /// di_container + /// .bind::<AudioManager>() + /// .to::<AudioManager>()? + /// .in_singleton_scope(); + /// + /// { + /// let audio_manager = di_container.get::<AudioManager>()?.singleton()?; + /// + /// audio_manager.play_long_sound(); + /// } + /// + /// let audio_manager = di_container.get::<AudioManager>()?.singleton()?; + /// + /// assert!(audio_manager.is_sound_playing()); + /// # + /// # Ok(()) + /// # } + /// ``` pub fn in_singleton_scope( self, ) -> Result< 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, diff --git a/src/di_container/blocking/mod.rs b/src/di_container/blocking/mod.rs index 69efe9a..df6e68c 100644 --- a/src/di_container/blocking/mod.rs +++ b/src/di_container/blocking/mod.rs @@ -95,6 +95,30 @@ impl DIContainer impl DIContainer { /// Returns a new [`BindingBuilder`] for the given interface. + /// + /// # Examples + /// ``` + /// # use syrette::{DIContainer, injectable}; + /// # + /// # struct DiskWriter {} + /// # + /// # #[injectable] + /// # impl DiskWriter + /// # { + /// # fn new() -> Self + /// # { + /// # Self {} + /// # } + /// # } + /// # + /// # fn main() -> Result<(), Box<dyn std::error::Error>> { + /// let mut di_container = DIContainer::new(); + /// + /// di_container.bind::<DiskWriter>().to::<DiskWriter>()?; + /// # + /// # Ok(()) + /// # } + /// ``` #[allow(clippy::missing_panics_doc)] pub fn bind<Interface>(&mut self) -> BindingBuilder<'_, Interface> where @@ -114,6 +138,32 @@ impl DIContainer /// - No binding for `Interface` exists /// - Resolving the binding for `Interface` fails /// - Casting the binding for `Interface` fails + /// + /// # Examples + /// ``` + /// # use syrette::{DIContainer, injectable}; + /// # + /// # struct DeviceManager {} + /// # + /// # #[injectable] + /// # impl DeviceManager + /// # { + /// # fn new() -> Self + /// # { + /// # Self {} + /// # } + /// # } + /// # + /// # fn main() -> Result<(), Box<dyn std::error::Error>> { + /// let mut di_container = DIContainer::new(); + /// + /// di_container.bind::<DeviceManager>().to::<DeviceManager>()?; + /// + /// let device_manager = di_container.get::<DeviceManager>()?.transient(); + /// # + /// # Ok(()) + /// # } + /// ``` pub fn get<Interface>(&self) -> Result<SomePtr<Interface>, DIContainerError> where Interface: 'static + ?Sized, @@ -128,6 +178,36 @@ impl DIContainer /// - No binding for `Interface` with name `name` exists /// - Resolving the binding for `Interface` fails /// - Casting the binding for `Interface` fails + /// + /// # Examples + /// ``` + /// # use syrette::{DIContainer, injectable}; + /// # + /// # struct DeviceManager {} + /// # + /// # #[injectable] + /// # impl DeviceManager + /// # { + /// # fn new() -> Self + /// # { + /// # Self {} + /// # } + /// # } + /// # + /// # fn main() -> Result<(), Box<dyn std::error::Error>> { + /// let mut di_container = DIContainer::new(); + /// + /// di_container + /// .bind::<DeviceManager>() + /// .to::<DeviceManager>()? + /// .in_transient_scope() + /// .when_named("usb")?; + /// + /// let device_manager = di_container.get_named::<DeviceManager>("usb")?.transient(); + /// # + /// # Ok(()) + /// # } + /// ``` pub fn get_named<Interface>( &self, name: &'static str, |