sword-core 0.2.1

Structured web framework built on top of tokio ecosystem, providing powerful features for building robust web applications.
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

use crate::{Config, State};
use serde::de::DeserializeOwned;

/// A struct that holds a function to register a config type.
/// Used by the inventory system to collect all config types at compile time.
pub struct ConfigRegistrar {
    pub register: fn(&State, &Config) -> (),
}

impl ConfigRegistrar {
    pub const fn new(register: fn(&State, &Config) -> ()) -> Self {
        Self { register }
    }
}

inventory::collect!(ConfigRegistrar);

/// Trait for configuration section types.
///
/// Types implementing this trait can be used with `Config::get()` to extract
/// and deserialize specific sections from the configuration table.
///
/// Use the `#[config(key = "section_name")]` macro to automatically implement this trait.
/// The macro will also auto-register the config type using the `inventory` crate.
///
/// ```rust,ignore
/// use sword::prelude::*;
///
/// #[config(key = "my_section")]
/// struct MyConfig {
///     value: String,
/// }
/// ```
pub trait ConfigItem: DeserializeOwned + Clone + Send + Sync + 'static {
    /// Returns the TOML section key for this configuration type.
    fn toml_key() -> &'static str;

    /// Registers this config type in the application State.
    /// This is called automatically during application bootstrap.
    fn register(state: &State, config: &Config) {
        let config_item = config.get::<Self>().unwrap_or_else(|_| {
            panic!(
                "Failed to load config item '{}' from the configuration file",
                Self::toml_key()
            )
        });

        state.insert(config_item);
    }
}