foxtive 0.25.6

Foxtive Framework
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
124
125
126
127
128
129

use std::fmt::{Debug, Formatter};
#[allow(unused_imports)]
use std::sync::Arc;

#[cfg(feature = "jwt")]
use crate::helpers::jwt::Jwt;
#[cfg(feature = "crypto")]
use crate::helpers::password::Password;
#[cfg(feature = "rabbitmq")]
use crate::rabbitmq::RabbitMQ;
#[cfg(feature = "redis")]
use crate::redis::Redis;
use crate::Environment;
#[cfg(feature = "templating")]
use tera::{Context, Tera};

/// The shared application state.
///
/// This struct holds all the shared state for the application, including database connections,
/// template engines, and other services.
#[derive(Clone)]
pub struct FoxtiveState {
    /// The application's environment (e.g., `Development`, `Production`).
    pub env: Environment,
    /// The application's code name.
    pub app_code: String,
    /// The application's name.
    pub app_name: String,
    /// The application's secret key.
    pub app_key: String,
    /// The application's private key.
    pub app_private_key: String,
    /// The application's public key.
    pub app_public_key: String,
    /// The prefix for environment variables.
    pub app_env_prefix: String,

    #[cfg(feature = "database")]
    /// The database connection pool.
    pub(crate) database: crate::database::DBPool,

    #[cfg(feature = "templating")]
    /// The Tera template engine.
    pub(crate) tera: Tera,

    #[cfg(feature = "redis")]
    /// The Redis connection pool.
    pub(crate) redis_pool: deadpool_redis::Pool,
    #[cfg(feature = "redis")]
    /// The Redis client.
    pub(crate) redis: Arc<Redis>,

    #[cfg(feature = "rabbitmq")]
    /// The RabbitMQ connection pool.
    pub rabbitmq_pool: deadpool_lapin::Pool,
    #[cfg(feature = "rabbitmq")]
    /// The RabbitMQ client.
    pub rabbitmq: Arc<tokio::sync::Mutex<RabbitMQ>>,

    /// The public key for the JWT issuer.
    #[cfg(feature = "jwt")]
    pub jwt_iss_public_key: String,

    /// The lifetime of the JWT token in minutes.
    #[cfg(feature = "jwt")]
    pub jwt_token_lifetime: i64,

    #[cfg(feature = "cache")]
    /// The cache client.
    pub cache: Arc<crate::cache::Cache>,

    /// A collection of helper utilities.
    pub helpers: FoxtiveHelpers,
}

#[derive(Clone)]
pub struct FoxtiveHelpers {
    #[cfg(feature = "jwt")]
    pub jwt: Arc<Jwt>,
    #[cfg(feature = "crypto")]
    pub password: Arc<Password>,
}

impl FoxtiveState {
    #[cfg(feature = "database")]
    pub fn database(&self) -> &crate::database::DBPool {
        &self.database
    }

    #[cfg(feature = "redis")]
    pub fn redis(&self) -> Arc<Redis> {
        self.redis.clone()
    }

    #[cfg(feature = "rabbitmq")]
    pub fn rabbitmq(&self) -> Arc<tokio::sync::Mutex<RabbitMQ>> {
        Arc::clone(&self.rabbitmq)
    }

    pub fn title(&self, text: &str) -> String {
        format!("{} - {}", text, self.app_name)
    }

    #[cfg(feature = "templating")]
    pub fn render(
        &self,
        file: impl Into<String>,
        context: &Context,
    ) -> crate::results::AppResult<String> {
        let mut file = file.into();
        if !file.ends_with(".tera.html") {
            file.push_str(".tera.html");
        }

        self.tera.render(&file, context).map_err(crate::Error::msg)
    }

    /// Get the Tera template engine.
    #[cfg(feature = "templating")]
    pub fn tera(&self) -> &Tera {
        &self.tera
    }
}

impl Debug for FoxtiveState {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.write_str("application state")
    }
}