arcature 0.1.2

Arcature: an opinionated full-stack Rust web framework. One package, batteries included.
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
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

//! The typed bundle of started subsystem handles passed to the application
//! state closure. Each field is `Some` only when the corresponding feature is
//! enabled and the subsystem connected successfully during startup.

// Every handle this bundle holds is behind a feature; with none enabled
// the struct has no fields and nothing to reference-count.
#[cfg(any(
    feature = "database",
    feature = "jobs",
    feature = "cache",
    feature = "storage-fs",
    feature = "mail"
))]
use std::sync::Arc;

/// The resources available to the application state closure after startup.
///
/// A stateless app ignores this; a fullstack app reads `resources.db()` etc.
/// Each accessor returns `Option` so the closure degrades gracefully when a
/// subsystem is disabled.
#[derive(Clone, Default)]
pub struct Resources {
    #[cfg(feature = "database")]
    db: Option<Arc<crate::database::Db>>,
    #[cfg(feature = "jobs")]
    jobs: Option<Arc<crate::jobs::Jobs>>,
    #[cfg(feature = "cache")]
    cache: Option<Arc<crate::cache::Cache>>,
    #[cfg(feature = "storage-fs")]
    storage: Option<Arc<crate::storage::Storage>>,
    #[cfg(feature = "mail")]
    mail: Option<Arc<crate::mail::Mailer>>,
}

impl Resources {
    /// An empty resource bundle (no subsystems connected).
    #[must_use]
    pub fn empty() -> Self {
        Self::default()
    }

    /// The database handle, when the `database` feature is enabled and the DB
    /// connected.
    #[cfg(feature = "database")]
    #[must_use]
    pub fn db(&self) -> Option<&crate::database::Db> {
        self.db.as_deref()
    }

    #[cfg(feature = "database")]
    #[cfg_attr(
        not(feature = "macros"),
        expect(dead_code, reason = "called only by the `macros`-gated startup path")
    )]
    pub(crate) fn set_db(&mut self, db: crate::database::Db) {
        self.db = Some(Arc::new(db));
    }

    /// The job queue facade, when the `jobs` feature is enabled and the queue
    /// connected. Use this to enqueue jobs from controllers and handlers.
    #[cfg(feature = "jobs")]
    #[must_use]
    pub fn jobs(&self) -> Option<&crate::jobs::Jobs> {
        self.jobs.as_deref()
    }

    #[cfg(feature = "jobs")]
    #[cfg_attr(
        not(feature = "macros"),
        expect(dead_code, reason = "called only by the `macros`-gated startup path")
    )]
    pub(crate) fn set_jobs(&mut self, jobs: crate::jobs::Jobs) {
        self.jobs = Some(Arc::new(jobs));
    }

    /// The cache handle, when the `cache` feature is enabled and connected.
    #[cfg(feature = "cache")]
    #[must_use]
    pub fn cache(&self) -> Option<&crate::cache::Cache> {
        self.cache.as_deref()
    }

    #[cfg(feature = "cache")]
    #[cfg_attr(
        not(feature = "macros"),
        expect(dead_code, reason = "called only by the `macros`-gated startup path")
    )]
    pub(crate) fn set_cache(&mut self, cache: crate::cache::Cache) {
        self.cache = Some(Arc::new(cache));
    }

    /// The storage handle, when the `storage-fs` feature is enabled.
    #[cfg(feature = "storage-fs")]
    #[must_use]
    pub fn storage(&self) -> Option<&crate::storage::Storage> {
        self.storage.as_deref()
    }

    #[cfg(feature = "storage-fs")]
    #[cfg_attr(
        not(feature = "macros"),
        expect(dead_code, reason = "called only by the `macros`-gated startup path")
    )]
    pub(crate) fn set_storage(&mut self, storage: crate::storage::Storage) {
        self.storage = Some(Arc::new(storage));
    }

    /// The mailer handle, when the `mail` feature is enabled.
    #[cfg(feature = "mail")]
    #[must_use]
    pub fn mail(&self) -> Option<&crate::mail::Mailer> {
        self.mail.as_deref()
    }

    #[cfg(feature = "mail")]
    #[cfg_attr(
        not(feature = "macros"),
        expect(dead_code, reason = "called only by the `macros`-gated startup path")
    )]
    pub(crate) fn set_mail(&mut self, mail: crate::mail::Mailer) {
        self.mail = Some(Arc::new(mail));
    }
}