Skip to main content

rust_dix/
entry.rs

1use crate::error::RdiError;
2use crate::key::ServiceKey;
3use crate::provider::ServiceProvider;
4use std::any::{Any, TypeId};
5use std::collections::HashMap;
6use std::future::Future;
7use std::pin::Pin;
8use std::sync::Arc;
9
10/// Service lifetime enum — defines how instances are cached.
11///
12/// - `Transient`: new instance every resolution (never cached)
13/// - `Scoped`: one instance per scope (cached within the scope)
14/// - `Singleton`: one instance shared across all scopes (cached globally)
15#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
16pub enum ServiceLifetime {
17    Transient,
18    Scoped,
19    Singleton,
20}
21
22/// Service descriptor holds registration metadata for a service.
23///
24/// Created during `ServiceCollection` building and passed to `ServiceStore`
25/// to create `ServiceEntry`.
26#[derive(Clone)]
27pub struct ServiceDescriptor {
28    pub type_id: TypeId,
29    pub type_name: &'static str,
30    pub key: Option<ServiceKey>,
31    pub factory: ServiceFactory,
32    /// Factory used by `AnyKey` fallback registrations; receives the requested key.
33    pub keyed_factory: Option<KeyedServiceFactory>,
34    pub async_factory: Option<AsyncServiceFactory>,
35    pub lifetime: ServiceLifetime,
36}
37
38/// ServiceStore is the root registry — maps `TypeId` to all `ServiceEntry` entries.
39///
40/// Multiple entries per type exist when keyed variants are registered.
41pub type ServiceStore = HashMap<TypeId, Vec<ServiceEntry>>;
42
43/// Service resolver trait — the core DI resolution interface.
44///
45/// Provides both type-erased and generic resolution methods.
46///
47/// # Panic contract of `Option`-returning lookups
48///
49/// [`Self::get_any`], [`Self::get_keyed_any`], [`Self::get_by_type_id`] and
50/// [`Self::get_keyed_by_type_id`] return `Option` because they answer "found or
51/// not". For a *registered* service that must not be resolved at this point
52/// (root scope validation under `validate_scopes`, a disposed provider/scope,
53/// circular dependency) implementations panic with a **typed [`RdiError`]**
54/// payload instead of returning `None`, so required-resolution APIs
55/// ([`Self::get`], `ServiceProvider::get`, …) can catch it and surface a precise
56/// `Err`. Constructor injection relies on this to propagate the real cause
57/// through user factories.
58///
59/// Infallible probing must use [`Self::try_get_any_result`] /
60/// [`Self::try_get_keyed_any_result`] (or `try_get` / `try_get_keyed`), which
61/// map such failures to `None`/`Err` without panicking.
62pub trait IServiceResolver: Send + Sync {
63    fn get_any(&self, key: &str) -> Option<Arc<dyn Any + Send + Sync>>;
64    fn get_keyed_any(&self, key: &str, variant: &str) -> Option<Arc<dyn Any + Send + Sync>>;
65
66    /// Typed-keyed resolution by type name (used by `#[inject(key = <expr>)]`).
67    ///
68    /// The default keeps external implementors source-compatible by falling back
69    /// to the string path **only for string-like keys**
70    /// ([`ServiceKey::as_str`]); typed keys require an implementor override
71    /// (`ServiceProvider`, `Scope`, `ServiceProviderWrapper` and the build-time
72    /// validation resolver all support typed keys).
73    fn get_keyed_any_key(
74        &self,
75        key: &str,
76        variant: &ServiceKey,
77    ) -> Option<Arc<dyn Any + Send + Sync>> {
78        self.get_keyed_any(key, variant.as_str()?)
79    }
80
81    /// Error-reporting typed-keyed lookup (used by required/optional inject
82    /// fields). Defaults to [`Self::get_keyed_any_key`].
83    fn try_get_keyed_any_result_key(
84        &self,
85        key: &str,
86        variant: &ServiceKey,
87    ) -> Result<Option<Arc<dyn Any + Send + Sync>>, RdiError> {
88        Ok(self.get_keyed_any_key(key, variant))
89    }
90
91    /// Typed-keyed owned resolution (bypasses caches; non-singleton only).
92    ///
93    /// Default keeps external implementors working for string-like keys.
94    fn get_keyed_owned_any_key(
95        &self,
96        key: &str,
97        variant: &ServiceKey,
98    ) -> Option<Arc<dyn Any + Send + Sync>> {
99        self.get_keyed_owned_any(key, variant.as_str()?)
100    }
101
102    /// Error-reporting typed-keyed owned lookup. Defaults to
103    /// [`Self::get_keyed_owned_any_key`].
104    fn try_get_keyed_owned_any_key(
105        &self,
106        key: &str,
107        variant: &ServiceKey,
108    ) -> Result<Option<Arc<dyn Any + Send + Sync>>, RdiError> {
109        Ok(self.get_keyed_owned_any_key(key, variant))
110    }
111
112    /// TypeId 直查(默认 `None`,`ServiceProvider` 等覆盖为 O(1) 直查)。
113    ///
114    /// 外部实现者若需优化可覆盖;不覆盖则 [`Self::get`] 默认实现 fallback
115    /// 到 [`Self::get_any`] 字符串路径。
116    ///
117    /// 覆盖实现须遵循 trait 级 panic 契约(注册但当前不可解析 → typed
118    /// [`RdiError`] payload panic,供 required API 捕获;可选探测请用
119    /// [`Self::try_get_any_result`])。
120    fn get_by_type_id(&self, _tid: TypeId) -> Option<Arc<dyn Any + Send + Sync>> {
121        None
122    }
123    /// TypeId 直查 keyed 版本(默认 `None`)。
124    ///
125    /// 覆盖实现须遵循 trait 级 panic 契约(见 [`Self::get_by_type_id`])。
126    fn get_keyed_by_type_id(&self, _tid: TypeId, _key: &str) -> Option<Arc<dyn Any + Send + Sync>> {
127        None
128    }
129
130    /// Type-erased polymorphic resolution: return all **unkeyed** registered
131    /// instances of the given type, in registration order.
132    ///
133    /// Equivalent to C# MEDI `GetServices<T>()` / `IEnumerable<IFoo>`
134    /// constructor injection, which also excludes keyed services.
135    /// Keyed implementations are enumerated with [`Self::get_all_keyed_any`].
136    ///
137    /// Default empty `Vec` keeps external implementors backward-compatible.
138    fn get_all_any(&self, _key: &str) -> Vec<Arc<dyn Any + Send + Sync>> {
139        Vec::new()
140    }
141
142    /// Type-erased polymorphic resolution over **keyed** registrations only
143    /// (MEDI `GetKeyedServices<T>(KeyedService.AnyKey)`).
144    ///
145    /// Default empty `Vec` keeps external implementors backward-compatible.
146    fn get_all_keyed_any(&self, _key: &str) -> Vec<Arc<dyn Any + Send + Sync>> {
147        Vec::new()
148    }
149
150    /// Error-reporting variant of [`Self::get_all_any`], used by the inject
151    /// macros for `Vec<Arc<T>>` fields.
152    ///
153    /// Containers that can fail (scope validation, disposal, factory errors)
154    /// override it so constructor injection surfaces a typed [`RdiError`]
155    /// instead of silently returning a partial/empty list. The default keeps
156    /// external implementors source-compatible.
157    fn get_all_any_result(&self, key: &str) -> Result<Vec<Arc<dyn Any + Send + Sync>>, RdiError> {
158        Ok(self.get_all_any(key))
159    }
160
161    /// Return an `Arc<ServiceProvider>` for on-demand service resolution.
162    ///
163    /// Used by `#[inject(provider)]` to give a service access to the DI container
164    /// so it can resolve scoped/owned instances on-demand (e.g., per-request
165    /// `DbContext` in a web handler, or per-tick scopes in a singleton worker).
166    ///
167    /// Available during `build()` as well: validation executes singleton
168    /// factories against the real provider, so `#[inject(provider)]` works in
169    /// eagerly built singletons too.
170    ///
171    /// Returns `None` only for resolvers not backed by a `ServiceProvider`.
172    ///
173    /// Default `None` keeps external implementors backward-compatible.
174    fn provider_arc(&self) -> Option<Arc<ServiceProvider>> {
175        None
176    }
177
178    /// Resolve a service by type (concrete or `dyn Trait`).
179    /// Returns `Err(RdiError::ServiceNotFound)` if not registered.
180    ///
181    /// 优先走 `get_by_type_id`(O(1) TypeId 直查),未覆盖时 fallback
182    /// 到 `get_any` 字符串路径。
183    fn get<T: ?Sized + Sync + Send + 'static>(&self) -> Result<Arc<T>, RdiError>
184    where
185        Self: Sized,
186    {
187        let type_name = std::any::type_name::<T>();
188        let tid = TypeId::of::<T>();
189        self.get_by_type_id(tid)
190            .or_else(|| self.get_any(type_name))
191            .and_then(|a| a.downcast::<Arc<T>>().ok().map(|d| Arc::clone(&*d)))
192            .ok_or_else(|| RdiError::not_found(type_name, None))
193    }
194
195    /// Resolve a service by type, returning `None` if it is not registered or
196    /// not resolvable at this point (e.g. a scoped service under root scope
197    /// validation, or a disposed provider/scope).
198    ///
199    /// Uses [`Self::try_get_any_result`]; containers override it with an
200    /// infallible lookup so `try_get` never panics for framework-level failures.
201    fn try_get<T: ?Sized + Sync + Send + 'static>(&self) -> Option<Arc<T>>
202    where
203        Self: Sized,
204    {
205        let type_name = std::any::type_name::<T>();
206        self.try_get_any_result(type_name)
207            .ok()
208            .flatten()
209            .and_then(|a| a.downcast::<Arc<T>>().ok().map(|d| Arc::clone(&*d)))
210    }
211
212    /// Fallible, type-erased lookup used by [`Self::try_get`].
213    ///
214    /// Default implementation delegates to [`Self::get_any`] (so external
215    /// resolvers keep working); containers that can fail override it so
216    /// infallible lookups can distinguish "absent" from "resolution error"
217    /// without panicking.
218    fn try_get_any_result(
219        &self,
220        key: &str,
221    ) -> Result<Option<Arc<dyn Any + Send + Sync>>, RdiError> {
222        Ok(self.get_any(key))
223    }
224
225    /// Resolve a keyed service by type and key. Returns `Err` if not found.
226    fn get_keyed<T: ?Sized + Sync + Send + 'static>(
227        &self,
228        variant: &str,
229    ) -> Result<Arc<T>, RdiError>
230    where
231        Self: Sized,
232    {
233        let type_name = std::any::type_name::<T>();
234        let tid = TypeId::of::<T>();
235        self.get_keyed_by_type_id(tid, variant)
236            .or_else(|| self.get_keyed_any(type_name, variant))
237            .and_then(|a| a.downcast::<Arc<T>>().ok().map(|d| Arc::clone(&*d)))
238            .ok_or_else(|| RdiError::keyed_not_found(type_name, variant, None))
239    }
240
241    /// Resolve a keyed service by type and key, returning `None` if not found or
242    /// not resolvable at this point (e.g. root scope validation, disposed
243    /// provider/scope). Never panics for framework-level failures.
244    fn try_get_keyed<T: ?Sized + Sync + Send + 'static>(&self, variant: &str) -> Option<Arc<T>>
245    where
246        Self: Sized,
247    {
248        let type_name = std::any::type_name::<T>();
249        self.try_get_keyed_any_result(type_name, variant)
250            .ok()
251            .flatten()
252            .and_then(|a| a.downcast::<Arc<T>>().ok().map(|d| Arc::clone(&*d)))
253    }
254
255    /// Fallible, type-erased keyed lookup used by [`Self::try_get_keyed`].
256    ///
257    /// Default implementation delegates to [`Self::get_keyed_any`]; containers
258    /// override it to return `None`/`Err` without panicking.
259    fn try_get_keyed_any_result(
260        &self,
261        key: &str,
262        variant: &str,
263    ) -> Result<Option<Arc<dyn Any + Send + Sync>>, RdiError> {
264        Ok(self.get_keyed_any(key, variant))
265    }
266
267    /// Resolve all **unkeyed** registered instances of `T`, in registration
268    /// order.
269    ///
270    /// Equivalent to C# MEDI `GetServices<T>()` (which also excludes keyed
271    /// services). Types implementing `IServiceResolver` get this for free via
272    /// `get_all_any`; types with an inherent `get_all<T>` method (e.g.
273    /// `ServiceProvider`, `Scope`) use that instead — Rust's method resolution
274    /// gives inherent methods priority over trait methods.
275    fn get_all<T: ?Sized + Sync + Send + 'static>(&self) -> Vec<Arc<T>>
276    where
277        Self: Sized,
278    {
279        self.get_all_any(std::any::type_name::<T>())
280            .into_iter()
281            .filter_map(|a| a.downcast::<Arc<T>>().ok().map(|d| Arc::clone(&*d)))
282            .collect()
283    }
284
285    /// Type-erased owned resolution: bypass cache, call factory fresh, return
286    /// `Arc<dyn Any + Send + Sync>` (concrete `Arc<Arc<T>>`).
287    ///
288    /// - Singleton → `None` (shared singleton cannot be owned).
289    /// - Scoped/Transient → factory invoked directly (no cache read/write),
290    ///   caller downcasts + `Arc::try_unwrap` to obtain owned `T`.
291    ///
292    /// Default `None` keeps external implementors backward-compatible.
293    fn get_owned_any(&self, _key: &str) -> Option<Arc<dyn Any + Send + Sync>> {
294        None
295    }
296    fn get_keyed_owned_any(
297        &self,
298        _key: &str,
299        _variant: &str,
300    ) -> Option<Arc<dyn Any + Send + Sync>> {
301        None
302    }
303
304    /// Resolve owned `T` (bypass cache, fresh each call).
305    /// Returns `Err` if not registered or the service is Singleton.
306    fn get_owned<T: Send + Sync + 'static>(&self) -> Result<T, RdiError>
307    where
308        Self: Sized,
309    {
310        let type_name = std::any::type_name::<T>();
311        let arc_any = self
312            .get_owned_any(type_name)
313            .ok_or_else(|| RdiError::not_found(type_name, None))?;
314        let arc_t: Arc<T> = arc_any
315            .downcast::<Arc<T>>()
316            .ok()
317            .map(|d| Arc::clone(&*d))
318            .ok_or_else(|| RdiError::not_found(type_name, None))?;
319        Arc::try_unwrap(arc_t).map_err(|_| RdiError::OwnedNotSupported(type_name))
320    }
321
322    /// Resolve owned `T`, returning `None` if not registered or Singleton.
323    fn try_get_owned<T: Send + Sync + 'static>(&self) -> Option<T>
324    where
325        Self: Sized,
326    {
327        let arc_any = self.get_owned_any(std::any::type_name::<T>())?;
328        let arc_t: Arc<T> = arc_any.downcast::<Arc<T>>().ok().map(|d| Arc::clone(&*d))?;
329        Arc::try_unwrap(arc_t).ok()
330    }
331
332    /// Resolve owned keyed `T`.
333    /// Returns `Err` if not found or Singleton.
334    fn get_keyed_owned<T: Send + Sync + 'static>(&self, variant: &str) -> Result<T, RdiError>
335    where
336        Self: Sized,
337    {
338        let type_name = std::any::type_name::<T>();
339        let arc_any = self
340            .get_keyed_owned_any(type_name, variant)
341            .ok_or_else(|| RdiError::keyed_not_found(type_name, variant, None))?;
342        let arc_t: Arc<T> = arc_any
343            .downcast::<Arc<T>>()
344            .ok()
345            .map(|d| Arc::clone(&*d))
346            .ok_or_else(|| RdiError::keyed_not_found(type_name, variant, None))?;
347        Arc::try_unwrap(arc_t).map_err(|_| RdiError::OwnedNotSupported(type_name))
348    }
349
350    /// Resolve owned keyed `T`, returning `None` if not found or Singleton.
351    fn try_get_keyed_owned<T: Send + Sync + 'static>(&self, variant: &str) -> Option<T>
352    where
353        Self: Sized,
354    {
355        let arc_any = self.get_keyed_owned_any(std::any::type_name::<T>(), variant)?;
356        let arc_t: Arc<T> = arc_any.downcast::<Arc<T>>().ok().map(|d| Arc::clone(&*d))?;
357        Arc::try_unwrap(arc_t).ok()
358    }
359}
360
361pub struct ServiceEntry {
362    pub cache_key: usize,
363    pub key: Option<ServiceKey>,
364    pub type_name: &'static str, // kept for IServiceResolver string-based resolution
365    /// Primary sync factory (typed, resolver-only).
366    pub factory: ServiceFactory,
367    /// `AnyKey` fallback factory; receives the requested key.
368    pub keyed_factory: Option<KeyedServiceFactory>,
369    pub async_factory: Option<AsyncServiceFactory>,
370    pub lifetime: ServiceLifetime,
371}
372
373impl ServiceEntry {
374    /// Whether this registration requires async initialization.
375    pub(crate) fn is_async(&self) -> bool {
376        self.async_factory.is_some()
377    }
378
379    /// Whether this is an `AnyKey` fallback registration.
380    pub(crate) fn is_any_key(&self) -> bool {
381        self.key.as_ref().is_some_and(ServiceKey::is_any)
382    }
383}
384
385pub type ServiceFactory =
386    Arc<dyn Fn(&dyn IServiceResolver) -> Arc<dyn Any + Send + Sync> + Send + Sync>;
387
388/// Factory for `AnyKey` fallback registrations: receives the requested key.
389pub type KeyedServiceFactory =
390    Arc<dyn Fn(&dyn IServiceResolver, &ServiceKey) -> Arc<dyn Any + Send + Sync> + Send + Sync>;
391
392/// Async variant of [`ServiceFactory`] — for services that require async
393/// initialization (e.g., database connections, remote config loading).
394///
395/// Used with [`ServiceCollection::build_async`](crate::collection::ServiceCollection::build_async).
396/// The factory receives an `Arc<ServiceProvider>` (instead of `&dyn IServiceResolver`)
397/// because async closures cannot borrow from the caller's stack frame.
398pub type AsyncServiceFactory = Arc<
399    dyn Fn(Arc<ServiceProvider>) -> Pin<Box<dyn Future<Output = Arc<dyn Any + Send + Sync>> + Send>>
400        + Send
401        + Sync,
402>;