Camo

文档 | 仓库 | 版本

Camo 是一个库，用于将 Rust 类型定义转换为其他语言中的对应定义。

• 抽象语法树 - Camo 提供了一系列数据结构，用于描述 Rust 语法的一个子集。语法树以 core::Container 为根，这些类型通过 core::Camo 特性提供。

• Derive 宏 - derive::Camo derive 宏自动化为您的类型创建语法树的工作。该宏考虑了 serde 属性，确保生成的类型能够准确描述 serde 会生成的值。

• TypeScript 后端 - typescript 模块提供了一个现成的 TypeScript 后端。将 core::Container 转换为 typescript::Definition，并将其写入文件。

入门指南

将 Camo 添加为依赖项

# `derive` is included by default
cargo add camo
# optionally add the typescript backend
cargo add camo --features typescript

将 Camo derive 宏添加到您的类型中

use camo::Camo;

#[derive(Camo)]
struct Book {
    title: String,
    author: String,
    page_count: usize,
    chapters: Vec<String>,
}

使用生成的 Camo::camo() 实现

fn main() {
    let book = Book::camo();
    println!("{:?}", book);
}

启用 typescript 功能后，创建 TypeScript 定义

use camo::{
    /* ... */
    typescript::Definition,
};

/* ... */

fn main() {

    /* ... */

    let ty: Definition = book.into();

    println!("{}", ty);
    // interface Book {
    //     title: string;
    //     author: string;
    //     page_count: number;
    //     chapters: string[];
    // }
}

更多示例请见此处。

特性

Crate

本项目由多个 crate 组成，以便组织特性。

请注意，只有 camo 是用于一般用途的。

许可证

camo 在 MIT 许可证的条款下分发。有关详细信息，请参阅 LICENSE。