Rust libs day0

这是一个用于学习和使用 rust crates lib 包，然后总结一些特点和使用方法以及资料的一个系列。

• Rust libs day0
  • serde
    • derive feature 的使用
    • derive attrs
  • serde 支持的数据类型

serde

简介： A serialization framework for Rust. 也就是一个用于序列化与反序列化的框架，序列化是指将数据结构或对象状态转换为一个可以存储或传输的格式（通常是一个字节流或字符串），而反序列化则是将这种格式恢复成原始的数据结构或对象状态。更通俗的讲吗，则是将代码数据变成字符串，以及把传入的字符串反序列化成代码实体。

链接：https://docs.rs/serde/latest/serde/

注意事项：

1. serde 只是一个框架，需要配合其它库使用，比如 serde_json、serde_yaml、serde_xml 等等。从而实现对对应的格式的文件的序列化与反序列化。

• 因而在 cargo.toml 里需要添加完整的依赖。

例如我需要将我的一个 .toml 配置文件转换成 struct，那么就需要用到 serde_toml。

  # ...
  # < snip > # 忽略前面的一些设置
  [dependencies]
  serde = { version = "1.0", features = ["derive"] } # 使用了 derive 性 ---> #[derive(Serialize, Deserialize)] 可以像这样使用
  serde_toml = "1.0"

derive feature 的使用

我的 config.toml 文件

[log_config]
stdout = { enable = true, level = "info" }
stderr = { enable = false, level = "error" }
log_file = { enable = true, level = "debug", file_path = "log.log" }
database = { enable = false, level = "info", file_path = "./log.db", env="./env" }
metrics_target = { enable = true, level = "info", file_path = "metrics.log" }

rust 代码数据结构

#[derive(Debug, Deserialize)]
struct Config {
    log_config: LogConfig,
}

#[derive(Debug, Deserialize)]
struct LogConfig {
    stdout: EnableConfig,
    stderr: EnableConfig,
    log_file: EnableConfig,
    database: EnableConfig,
    metrics_target: EnableConfig,
}

#[derive(Debug, Deserialize)]
struct EnableConfig {
    pub enable: bool,
    pub level: Option<TLevel>, 
    // Option type 意味着 config.toml 里可以不写，则默认是 None
    pub file_path: Option<String>,
    pub env: Option<String>,
}

#[derive(Debug, Deserialize)]
#[serde(rename_all = "lowercase")] 
 // 枚举类型重命名，使其全部小写，从而能够匹配上 config.toml 里的字符串
enum TLevel {
    Trace = 0,
    Debug = 1,
    Info = 2,
    Warn = 3,
    Error = 4,
}

将 config.toml 转换成 Config 结构

fn main() -> Result<(), Box<dyn std::error::Error>> {
  let file = "config.toml";
  let config_file = std::fs::read_to_string(file)?;
  let config: Config = toml::from_str(&config_file)?;
   // 这里明确了 config 为 Config 结构，
   // toml 则可以尝试将传入的字符串转换成 Config 结构，
   // 如果转换失败，则返回错误
}

derive attrs

serde 支持的 derive attr 有很多，大致分为这三类：

1. Container attributes — 应用于结构或枚举声明
   • apply to a struct or enum declaration.
2. Variant attributes — 应用于枚举的变体。
   • apply to a variant of an enum.
3. Field attributes — 应用于结构体或枚举变量中的一个字段。
   • apply to one field in a struct or in an enum variant.

可以参考 https://serde.rs/attributes.html

serde 支持的数据类型

内容来自：https://docs.rs/serde/latest/serde/#data-formats