type_description

此 crate 提供类型可机器读取的描述。

一般概述，请参阅 指南。

想法是通过对用户进行解释，使类型可被发现，而无需了解实现细节（例如，u16 是一个“16位整数”）

示例

可以用这个 crate 解释配置类型，并将解释（在 GUI、Web 界面、某些特殊的配置编辑器中）显示给用户。

use type_description::AsTypeDescription;
use type_description::TypeDescription;
use type_description::TypeKind;
use type_description::Sign;

/// A configuration
#[derive(TypeDescription)]
struct Config {
    /// The bind address
    addr: std::net::SocketAddr,

    /// The Port
    port: u16,
}

let desc = Config::as_type_description();

assert_eq!(desc.name(), "Config");
assert_eq!(desc.doc(), Some("A configuration"));
assert!(std::matches!(desc.kind(), TypeKind::Struct(_)));

match desc.kind() {
    TypeKind::Struct(v) => {
        let first_field = &v[0];
        assert_eq!(first_field.name(), "addr");
        assert_eq!(first_field.doc(), Some("The bind address"));
        assert_eq!(first_field.kind().name(), "String");
        assert_eq!(first_field.kind().doc(), Some("A socket address"));
        assert_eq!(*first_field.kind().kind(), type_description::TypeKind::String);

        let second_field = &v[1];
        assert_eq!(second_field.name(), "port");
        assert_eq!(second_field.doc(), Some("The Port"));
        assert_eq!(second_field.kind().name(), "Integer");
        assert_eq!(second_field.kind().doc(), Some("An unsigned integer with 16 bits"));
        assert_eq!(*second_field.kind().kind(), type_description::TypeKind::Integer { size: 16, sign: Sign::Unsigned });
    }
    _ => unreachable!()
}

额外类型

此 crate 包含了为各种第三方 crate 实现的 AsTypeDescription。最新列表可以在 docs.rs 上找到。

目标

• 遵循 serde 模型并与所有 serde::{Deserialize, Serialize} 类型兼容
• 为实现 AsTypeDescription 的类型生成可机器读取的描述