axum-config 0.1.0

Proc macros for axum-config
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

mod config;
mod env;
mod error;
mod extract;

use serde::de::DeserializeOwned;

pub use config::Config;
pub use error::ConfigError;
pub use extract::*;

pub use axum_config_macros::config;

/// 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.
///
/// # Example
///
/// ```ignore
/// use axum_config::config;
/// use serde::Deserialize;
///
/// #[config(key = "database")]
/// #[derive(Debug, Clone, Deserialize)]
/// pub struct DatabaseConfig {
///     pub host: String,
///     pub port: u16,
/// }
/// ```
pub trait ConfigItem: DeserializeOwned + Clone + Send + Sync + 'static {
    /// Returns the TOML section key for this configuration type.
    fn key() -> &'static str;
}