rudi-dev 0.8.7

Rudi - an out-of-the-box dependency injection framework for Rust.
Documentation 
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

use crate::{DynProvider, Type};

/// Represents a module.
///
/// # Example
///
/// ```rust
/// use rudi::{
///     modules, providers, singleton, transient, Context, DynProvider, Module, ResolveModule,
/// };
///
/// struct Module1;
///
/// impl Module for Module1 {
///     fn eager_create() -> bool {
///         true
///     }
///
///     fn providers() -> Vec<DynProvider> {
///         providers![singleton(|_| "Hello").name("1")]
///     }
/// }
///
/// struct Module2;
///
/// impl Module for Module2 {
///     fn submodules() -> Option<Vec<ResolveModule>> {
///         Some(modules![Module1])
///     }
///
///     fn providers() -> Vec<DynProvider> {
///         providers![transient(|_| "World").name("2")]
///     }
/// }
///
/// # fn main() {
/// let mut cx = Context::create(modules![Module2]);
/// let mut a = cx.resolve_by_type::<&'static str>();
/// a.sort();
/// assert!(format!("{:?}", a) == *r#"["Hello", "World"]"#);
/// # }
/// ```
pub trait Module {
    /// Whether the providers included in the module should be created eagerly, default is false.
    fn eager_create() -> bool {
        false
    }

    /// Included submodules, default is None.
    fn submodules() -> Option<Vec<ResolveModule>> {
        None
    }

    /// Included providers.
    fn providers() -> Vec<DynProvider>;
}

/// A type representing a Module, converted from a type that implements [`Module`].
pub struct ResolveModule {
    ty: Type,
    eager_create: bool,
    submodules: Option<Vec<ResolveModule>>,
    providers: Vec<DynProvider>,
}

impl ResolveModule {
    /// Create a [`ResolveModule`] from a type that implements [`Module`].
    pub fn new<T: Module + 'static>() -> Self {
        Self {
            ty: Type::new::<T>(),
            eager_create: T::eager_create(),
            submodules: T::submodules(),
            providers: T::providers(),
        }
    }

    /// Represents the type that is converted to a ResolveModule.
    pub fn ty(&self) -> Type {
        self.ty
    }

    /// Whether the providers included in the module should be created eagerly.
    pub fn eager_create(&self) -> bool {
        self.eager_create
    }

    pub(crate) fn submodules(&mut self) -> Option<Vec<ResolveModule>> {
        self.submodules.take()
    }

    pub(crate) fn providers(self) -> Vec<DynProvider> {
        self.providers
    }
}