DesEnv-rs

环境变量反序列化库。

使用此库，可以将一组环境变量反序列化为更结构化的数据类型。

安装

# Cargo.toml
[dependencies]
desenv = "0.1.0"

使用方法

该库提供了一个实用函数，用于从环境变量中加载配置

fn main() {
    let _config: Config = desenv::load().expect("Failed to load configuration");
}

然后 Config 应该像这样

use desenv::Desenv;

#[derive(Desenv)]
pub struct Config {
    field1: String,
    field2: String,
}

为了成功加载 Config，在环境变量中需要两个变量

• FIELD1
• FIELD2

自定义配置

可以自定义配置的加载方式。

重命名

在 desenv 字段属性上使用 rename 修饰符，可以指示库查找不同的变量。在上面的示例中，在加载配置时，库将尝试查找 FIELD_1 变量。

use desenv::Desenv;

#[derive(Desenv)]
pub struct Config {
    #[desenv(rename = "FIELD_1")]
    field1: String,
}

请注意，重命名属性是区分大小写的。所以在上面的示例中，库将尝试查找一个名为 downcased_field_1 的环境变量。

use desenv::Desenv;

#[derive(Desenv)]
pub struct Config {
    #[desenv(rename = "down_case_field_1")]
    field1: String,
}

默认值

使用此修饰符可以指示库反序列化一个带有默认值的环境变量。

带值

如果 FIELD1 环境变量不存在，库将用 value 填充 field1。

use desenv::Desenv;

#[derive(Desenv)]
pub struct Config {
    #[desenv(default = "value")]
    field1: String,
}

或

use desenv::Desenv;

#[derive(Desenv)]
pub struct Config {
    #[desenv(default(value = "value"))]
    field1: String,
}

带环境变量

如果 FIELD1 环境变量不存在，库将尝试作为后备选项加载 FALLBACK_FIELD1 环境变量。如果 FALLBACK_FIELD1 也不存在，则加载将失败。

use desenv::Desenv;

#[derive(Desenv)]
pub struct Config {
    #[desenv(default(env = "FALLBACK_FIELD1"))]
    field1: String,
}

带标准默认值

如果 FIELD1 环境变量不存在，库将用该类型的 Default 实现填充 field1。例如，对于字符串，默认值将是一个空字符串。

use desenv::Desenv;

#[derive(Desenv)]
pub struct Config {
    #[desenv(default)]
    field1: String,
}

use desenv::Desenv;

#[derive(Desenv)]
pub struct Config {
    #[desenv(separator = ';')]
    field1: String,
}

use desenv::Desenv;

#[derive(Desenv)]
pub struct Config {
    #[desenv(nested)]
    field1: NestedConfig,
}

#[derive(Desenv)]
pub struct NestedConfig {
    field: String,
}

use desenv::Desenv;

#[derive(Desenv)]
#[desenv(prefix = "PREFIX_")]
pub struct Config {
    field1: String,
}

use desenv::Desenv;

#[derive(Desenv)]
#[desenv(prefix = "PARENT_")]
pub struct Config {
    #[desenv(nested)]
    field1: NestedConfig,
}

#[derive(Desenv)]
#[desenv(prefix = "NESTED_")]
pub struct NestedConfig {
    field: String,
}

use std::ffi::OsString;
use desenv::Desenv;

#[derive(Desenv)]
pub struct Config {
    field1: OsString,
}