ultimate 0.1.0

Rust libraries
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

//! 通用配置文件[^config]。
//! 默认配置在 `src/config/default.toml` 文件提供。
//!
//! [^config]: 使用了 crate [config](https://docs.rs/config)
use std::{env, str::FromStr, sync::Arc};

use ::config::Config;

pub use error::{Error, Result};
use ultimate_common::string::b64u_decode;
pub use fusion_config::*;
pub use trace_config::{LogWriterType, TraceConfig};

pub(crate) use self::util::load_config;

mod error;
mod fusion_config;
mod trace_config;
mod util;

#[derive(Clone)]
pub struct ConfigState {
  underling: Arc<Config>,
  fusion_config: Arc<FusionConfig>,
}

impl ConfigState {
  /// 秦岭配置文件根，支持通过环境变量覆盖默认配置。
  ///
  /// # Examples
  ///
  /// ```rust
  /// # use ultimate::configuration::*;
  /// # fn test_config_state_from_env() {
  /// // 两个下划线作为层级分隔符
  /// std::env::set_var("FUSION__WEB__SERVER_ADDR", "0.0.0.0:8000");
  ///
  /// std::env::set_var(
  ///     "FUSION__TOKEN_KEY",
  ///     "8462b1ec9af827ebed13926f8f1e5409774fa1a21a1c8f726a4a34cf7dcabaf2",
  /// );
  /// std::env::set_var("FUSION__PWD_KEY", "80c9a35c0f231219ca14c44fe10c728d");
  ///
  /// let config_state = ConfigState::load().unwrap();
  /// let qc = config_state.fusion_config();
  ///
  /// assert_eq!(qc.pwd_key, b"80c9a35c0f231219ca14c44fe10c728d");
  /// assert_eq!(
  ///     qc.token_key,
  ///     b"--8462b1ec9af827ebed13926f8f1e5409774fa1a21a1c8f726a4a34cf7dcabaf2"
  /// );
  ///
  /// // 由默认配置文件提供
  /// assert_eq!(&qc.web().server_addr, "0.0.0.0:8000");
  /// assert_eq!(&qc.app().name, "ultimate");
  /// # }
  /// ```
  ///
  pub(crate) fn load() -> Result<Self> {
    let c = load_config()?;
    let fusion_config = FusionConfig::try_from(&c)?;
    Ok(Self::new(Arc::new(c), Arc::new(fusion_config)))
  }

  pub(crate) fn new(underling: Arc<Config>, fusion_config: Arc<FusionConfig>) -> Self {
    Self { underling, fusion_config }
  }

  pub fn fusion_config(&self) -> &FusionConfig {
    self.fusion_config.as_ref()
  }

  pub fn fusion_config_clone(&self) -> Arc<FusionConfig> {
    self.fusion_config.clone()
  }

  pub fn underling(&self) -> &Config {
    self.underling.as_ref()
  }

  pub fn underling_clone(&self) -> Arc<Config> {
    self.underling.clone()
  }
}

pub fn get_env(name: &'static str) -> Result<String> {
  env::var(name).map_err(|_| Error::ConfigMissingEnv(name))
}

pub fn get_env_parse<T: FromStr>(name: &'static str) -> Result<T> {
  let val = get_env(name)?;
  val.parse::<T>().map_err(|_| Error::ConfigWrongFormat(name))
}

pub fn get_env_b64u_as_u8s(name: &'static str) -> Result<Vec<u8>> {
  b64u_decode(&get_env(name)?).map_err(|_| Error::ConfigWrongFormat(name))
}