1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
use std::any::Any;
use std::marker::PhantomData;
use std::sync::{Arc, Mutex};
use crate::InjectionError;
use crate::cache::Cache;
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// Controls the lifetime of an instance created by
/// [`Builders`][`crate::Builder`]
pub trait Scope {
fn get_or_create<Clb>(
&self,
cat: &crate::Catalog,
create_instance: Clb,
) -> Result<Arc<dyn Any + Send + Sync>, InjectionError>
where
Clb: FnOnce() -> Result<Arc<dyn Any + Send + Sync>, InjectionError>;
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Transient
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// The default scope. Never caches instances, so that every dependency
/// resolution will result in a new instance. This scope is intended for
/// short-lived objects and will result in validation error if you attempt to
/// inject it into objects with long-lived scopes like [`Singleton`]. Instances
/// that can be safely held on to can use the [`Agnostic`] scope.
pub struct Transient;
impl Default for Transient {
fn default() -> Self {
Self::new()
}
}
impl Transient {
pub fn new() -> Self {
Self {}
}
}
impl Scope for Transient {
fn get_or_create<Clb>(
&self,
_cat: &crate::Catalog,
create_instance: Clb,
) -> Result<Arc<dyn Any + Send + Sync>, InjectionError>
where
Clb: FnOnce() -> Result<Arc<dyn Any + Send + Sync>, InjectionError>,
{
create_instance()
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Agnostic
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// Behaves the same as [`Transient`] scope, but is used to explicitly signal
/// that it's OK to inject the instances of this type into scopes that may hold
/// on to them for a long time.
pub struct Agnostic;
impl Default for Agnostic {
fn default() -> Self {
Self::new()
}
}
impl Agnostic {
pub fn new() -> Self {
Self {}
}
}
impl Scope for Agnostic {
fn get_or_create<Clb>(
&self,
_cat: &crate::Catalog,
create_instance: Clb,
) -> Result<Arc<dyn Any + Send + Sync>, InjectionError>
where
Clb: FnOnce() -> Result<Arc<dyn Any + Send + Sync>, InjectionError>,
{
create_instance()
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Singleton
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// Caches an instance upon first creation for the entire duration of the
/// program.
pub struct Singleton {
instance: Mutex<Option<Arc<dyn Any + Send + Sync>>>,
}
impl Default for Singleton {
fn default() -> Self {
Self::new()
}
}
impl Singleton {
pub fn new() -> Self {
Self {
instance: Mutex::new(None),
}
}
}
impl Scope for Singleton {
fn get_or_create<Clb>(
&self,
_cat: &crate::Catalog,
create_instance: Clb,
) -> Result<Arc<dyn Any + Send + Sync>, InjectionError>
where
Clb: FnOnce() -> Result<Arc<dyn Any + Send + Sync>, InjectionError>,
{
let mut cached = self.instance.lock().unwrap();
if let Some(inst) = cached.as_ref() {
Ok(inst.clone())
} else {
let inst = create_instance()?;
*cached = Some(inst.clone());
Ok(inst)
}
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Cached
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// Caches instances inside the specified [`Cache`] object. See [`Transaction`]
/// for common use case and examples.
pub struct Cached<T: Cache> {
_ph: PhantomData<T>,
}
impl<T: Cache> Cached<T> {
pub fn new() -> Self {
Self::default()
}
}
impl<T: Cache> Default for Cached<T> {
fn default() -> Self {
Self {
_ph: Default::default(),
}
}
}
impl<T: Cache> Scope for Cached<T> {
fn get_or_create<Clb>(
&self,
cat: &crate::Catalog,
create_instance: Clb,
) -> Result<Arc<dyn Any + Send + Sync>, InjectionError>
where
Clb: FnOnce() -> Result<Arc<dyn Any + Send + Sync>, InjectionError>,
{
let id = self as *const Self as usize;
let cache = cat.get_one::<T>()?;
if let Some(inst) = cache.get(id) {
Ok(inst.clone())
} else {
let inst = create_instance()?;
cache.set(id, inst.clone());
Ok(inst)
}
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Transaction
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/// A scope that caches instances within a current transaction. Transaction
/// boundaries are defined by adding [`TransactionCache`] instance into
/// a chained catalog.
///
/// Example use:
/// ```
/// #[dill::component]
/// #[dill::scope(dill::scopes::Transaction)]
/// struct Foo {}
///
/// // Init your base catalog
/// let base_catalog = dill::Catalog::builder()
/// .add::<Foo>()
/// .build();
///
/// // In some middleware (e.g. axum)
/// {
/// // Create chained catalog for duration of the transaction
/// // and add `TrasactionCache` to it to hold cached instances
/// let tx_catalog = base_catalog
/// .builder_chained()
/// .add_value(dill::scopes::TransactionCache::new())
/// .build();
///
/// // Further in code inject `Foo` somewhere
/// let foo1 = tx_catalog.get_one::<Foo>().unwrap();
///
/// // Next time you inhect `Foo` - you'll get the same instance
/// let foo2 = tx_catalog.get_one::<Foo>().unwrap();
/// assert_eq!(
/// foo1.as_ref() as *const Foo,
/// foo2.as_ref() as *const Foo,
/// );
///
/// // When chained catalog is dropped - the cache is dropped along with it
/// }
/// ```
pub type Transaction = Cached<TransactionCache>;
/// Just a newtype wrapper for [`CacheImpl`] to give it a specific type
/// identity. Used by [`Transaction`] scope.
#[derive(Default)]
pub struct TransactionCache(crate::cache::CacheImpl);
impl TransactionCache {
pub fn new() -> Self {
Self::default()
}
}
impl Cache for TransactionCache {
#[inline(always)]
fn get(&self, id: usize) -> Option<Arc<dyn Any + Send + Sync>> {
self.0.get(id)
}
#[inline(always)]
fn set(&self, id: usize, inst: Arc<dyn Any + Send + Sync>) {
self.0.set(id, inst)
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////