modo-rs 0.6.2

Rust web framework for small monolithic apps
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

use serde::Deserialize;

/// Top-level framework configuration.
///
/// Deserializes from a YAML file loaded by [`crate::config::load`]. All fields
/// use `#[serde(default)]`, so any section omitted from the YAML file falls
/// back to the type's own `Default` implementation.
///
/// Applications that need extra config fields can embed `Config` with
/// `#[serde(flatten)]` inside their own config struct.
#[non_exhaustive]
#[derive(Debug, Clone, Deserialize, Default)]
#[serde(default)]
pub struct Config {
    /// HTTP server bind address and shutdown behaviour.
    pub server: crate::server::Config,
    /// libsql database settings. Requires the `db` feature.
    #[cfg(feature = "db")]
    #[serde(default)]
    pub database: crate::db::Config,
    /// Log level, format, and optional Sentry integration.
    pub tracing: crate::tracing::Config,
    /// Signed cookie secret and attributes. When absent, signed/private cookies
    /// are disabled.
    pub cookie: Option<crate::cookie::CookieConfig>,
    /// HTTP security-header middleware settings.
    pub security_headers: crate::middleware::SecurityHeadersConfig,
    /// CORS policy.
    pub cors: crate::middleware::CorsConfig,
    /// CSRF protection settings.
    pub csrf: crate::middleware::CsrfConfig,
    /// Token-bucket rate-limiting settings.
    pub rate_limit: crate::middleware::RateLimitConfig,
    /// Session TTL, cookie name, fingerprint validation, touch interval, and
    /// per-user session limit. Requires the `session` feature.
    #[cfg(feature = "session")]
    #[serde(default)]
    pub session: crate::session::SessionConfig,
    /// Background job queue settings. Requires the `job` feature.
    #[cfg(feature = "job")]
    #[serde(default)]
    pub job: crate::job::JobConfig,
    /// CIDR ranges of trusted reverse proxies used by [`crate::ip::ClientIpLayer`].
    ///
    /// Accepts any string parseable as [`ipnet::IpNet`], e.g. `"10.0.0.0/8"`.
    #[serde(default)]
    pub trusted_proxies: Vec<String>,
    /// OAuth provider settings. Requires the `auth` feature.
    #[cfg(feature = "auth")]
    #[serde(default)]
    pub oauth: crate::auth::oauth::OAuthConfig,
    /// SMTP / email delivery settings. Requires the `email` feature.
    #[cfg(feature = "email")]
    #[serde(default)]
    pub email: crate::email::EmailConfig,
    /// MiniJinja template engine settings. Requires the `templates` feature.
    #[cfg(feature = "templates")]
    #[serde(default)]
    pub template: crate::template::TemplateConfig,
    /// MaxMind GeoIP database path and settings. Requires the `geolocation`
    /// feature.
    #[cfg(feature = "geolocation")]
    #[serde(default)]
    pub geolocation: crate::geolocation::GeolocationConfig,
    /// S3-compatible storage bucket settings. Requires the `storage` feature.
    #[cfg(feature = "storage")]
    #[serde(default)]
    pub storage: crate::storage::BucketConfig,
    /// DNS verification settings. Requires the `dns` feature.
    #[cfg(feature = "dns")]
    #[serde(default)]
    pub dns: crate::dns::DnsConfig,
    /// API key module settings. Requires the `apikey` feature.
    #[cfg(feature = "apikey")]
    #[serde(default)]
    pub apikey: crate::apikey::ApiKeyConfig,
    /// JWT signing and validation settings. Requires the `auth` feature.
    #[cfg(feature = "auth")]
    #[serde(default)]
    pub jwt: crate::auth::jwt::JwtConfig,
}