Struct ModuleRef 

pub struct ModuleRef { /* private fields */ }

Runtime provider container. This is Boot’s Rust equivalent of Nest’s ModuleRef.

Implementations

impl ModuleRef

pub fn new() -> Self

pub fn request_scope(&self) -> Self

pub fn context_scope(&self, context_id: &ContextId) -> Self

Bind this module view to an existing dependency-injection context.

pub fn context_id(&self) -> Option<&ContextId>

Return the dependency-injection context attached to this module view.

pub fn register(&self, definition: ProviderDefinition) -> Result<()>

pub async fn register_async(&self, definition: ProviderDefinition) -> Result<()>

pub fn insert<T>(&self, value: T) -> Result<()>

where T: Send + Sync + 'static,

pub fn insert_arc<T>(&self, value: Arc<T>) -> Result<()>

where T: Send + Sync + 'static,

pub fn get<T>(&self) -> Result<Arc<T>>

where T: Send + Sync + 'static,

pub fn get_named<T>(&self, token: &str) -> Result<Arc<T>>

where T: Send + Sync + 'static,

pub fn get_optional<T>(&self) -> Result<Option<Arc<T>>>

where T: Send + Sync + 'static,

pub fn get_optional_named<T>(&self, token: &str) -> Result<Option<Arc<T>>>

where T: Send + Sync + 'static,

pub fn provider_ref<T>(&self) -> ProviderRef<T>

where T: Send + Sync + 'static,

Create a lazy provider handle for a typed dependency.

pub fn named_provider_ref<T>(&self, token: &str) -> ProviderRef<T>

where T: Send + Sync + 'static,

Create a lazy provider handle for a named dependency.

pub fn optional_provider_ref<T>(&self) -> Result<Option<ProviderRef<T>>>

where T: Send + Sync + 'static,

Create a lazy provider handle only when the typed dependency is visible.

pub fn optional_named_provider_ref<T>( &self, token: &str, ) -> Result<Option<ProviderRef<T>>>

where T: Send + Sync + 'static,

Create a lazy provider handle only when the named dependency is visible.

pub fn resolve<T>(&self) -> Result<Arc<T>>

where T: Send + Sync + 'static,

Resolve a typed provider in a fresh resolution context.

This mirrors Nest’s ModuleRef.resolve(...): singleton providers reuse their application instance, while request-scoped dependencies share one temporary context for this resolution and transient providers are rebuilt.

pub fn resolve_with_context<T>(&self, context_id: &ContextId) -> Result<Arc<T>>

where T: Send + Sync + 'static,

Resolve a typed provider in a caller-supplied resolution context.

pub fn resolve_named<T>(&self, token: &str) -> Result<Arc<T>>

where T: Send + Sync + 'static,

Resolve a named provider in a fresh resolution context.

pub fn resolve_named_with_context<T>( &self, token: &str, context_id: &ContextId, ) -> Result<Arc<T>>

where T: Send + Sync + 'static,

Resolve a named provider in a caller-supplied resolution context.

pub fn resolve_optional<T>(&self) -> Result<Option<Arc<T>>>

where T: Send + Sync + 'static,

Resolve a typed provider in a fresh resolution context when it exists.

pub fn resolve_optional_with_context<T>( &self, context_id: &ContextId, ) -> Result<Option<Arc<T>>>

where T: Send + Sync + 'static,

Resolve an optional typed provider in a caller-supplied context.

pub fn resolve_optional_named<T>(&self, token: &str) -> Result<Option<Arc<T>>>

where T: Send + Sync + 'static,

Resolve a named provider in a fresh resolution context when it exists.

pub fn resolve_optional_named_with_context<T>( &self, token: &str, context_id: &ContextId, ) -> Result<Option<Arc<T>>>

where T: Send + Sync + 'static,

Resolve an optional named provider in a caller-supplied context.

pub fn create<T>(&self) -> Result<T>

where T: FromModuleRef,

Create an injectable value without registering it in the provider graph.

pub fn create_arc<T>(&self) -> Result<Arc<T>>

where T: FromModuleRef,

Create an injectable Arc<T> without registering it in the provider graph.

pub fn contains(&self, token: &ProviderToken) -> Result<bool>

pub fn contains_provider<T>(&self) -> Result<bool>

where T: Send + Sync + 'static,

pub fn contains_named(&self, token: &str) -> Result<bool>

pub fn provider_is_contextual<T>(&self) -> Result<bool>

where T: Send + Sync + 'static,

Return whether a typed provider requires a request-resolution context.

This includes explicitly request-scoped providers and singleton or transient providers whose declared dependency tree reaches one.

pub fn provider_scope<T>(&self) -> Result<ProviderScope>

where T: Send + Sync + 'static,

Return the provider’s declared cache scope after following aliases.

pub fn named_provider_is_contextual(&self, token: &str) -> Result<bool>

Return whether a named provider requires a request-resolution context.

pub fn named_provider_scope(&self, token: &str) -> Result<ProviderScope>

Return a named provider’s declared cache scope after following aliases.

pub fn tokens(&self) -> Result<Vec<ProviderToken>>

Trait Implementations

impl Clone for ModuleRef

fn clone(&self) -> ModuleRef

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModuleRef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ModuleRef

fn default() -> ModuleRef

Returns the “default value” for a type.