Struct Config 

pub struct Config { /* private fields */ }

Main configuration structure 主配置结构

Equivalent to Spring Boot’s ConfigurableEnvironment and ConfigFileApplicationListener. 等价于Spring Boot的ConfigFileApplicationListener和ConfigurableEnvironment。

Example / 示例

use hiver_config::Config;

let config = Config::builder()
    .add_file("config/application.yaml")
    .add_profile("dev")
    .build()?;

Implementations

impl Config

pub fn new() -> Self

Create a new empty configuration 创建新的空配置

pub fn builder() -> ConfigBuilder

Create a configuration builder 创建配置构建器

pub fn load() -> ConfigResult<Self>

Load configuration with default settings 使用默认设置加载配置

Default loading order / 默认加载顺序:

1. application.properties (or .yaml, .toml, .json)
2. application-{profile}.properties
3. System environment variables
4. Command line arguments

pub fn from_file<P: AsRef<Path>>(path: P) -> ConfigResult<Self>

Load configuration from a specific file 从特定文件加载配置

pub fn add_property_source(&self, source: PropertySource)

Add a property source 添加属性源

pub fn add_property_source_first(&self, source: PropertySource)

Add a property source with highest priority. 添加最高优先级的属性源。

pub fn get(&self, key: &str) -> Option<Value>

Get a property value 获取属性值

pub fn get_as<T>(&self, key: &str) -> ConfigResult<T>

where T: DeserializeOwned,

Get a property as a specific type 获取特定类型的属性

pub fn get_required(&self, key: &str) -> ConfigResult<Value>

Get a required property 获取必需属性

pub fn get_required_as<T>(&self, key: &str) -> ConfigResult<T>

where T: DeserializeOwned,

Get a required property as a specific type 获取特定类型的必需属性

pub fn get_or<T>(&self, key: &str, default: T) -> T

where T: DeserializeOwned,

Get property with default value 获取带默认值的属性

pub fn contains_key(&self, key: &str) -> bool

Check if a property exists 检查属性是否存在

pub fn get_prefix(&self, prefix: &str) -> IndexMap<String, Value>

Get all properties starting with a prefix 获取所有以指定前缀开头的属性

pub fn environment(&self) -> &Environment

Get environment reference 获取环境引用

pub fn files(&self) -> Vec<PathBuf>

Get loaded files 获取已加载的文件

pub fn reload_strategy(&self) -> ReloadStrategy

Get reload strategy 获取重新加载策略

pub fn reload(&self) -> ConfigResult<()>

Reload configuration 重新加载配置

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.