9个稳定版本

2.0.2	2023年10月2日
2.0.1	2023年9月3日
2.0.0	2023年8月22日
1.1.1	2023年8月10日

#32 在解析工具

77 每月下载量
用于 hhh

Apache-2.0

13MB
101K SLoC

托盘

托盘是一个平面、耐高温的物体，用作热盘和餐桌之间的障碍物，以保护餐桌免受热损伤。

托盘是一个 Rust 库，用于编写递归下降解析器。这些是 低级工具。托盘不是编写复杂语言解析器的简单库，也不是需要无界前瞻性语言的理想选择... 那又是什么呢？

为什么选择托盘

托盘可能不是你想要的解析库。你不是先描述你的语言，然后再从这个描述中生成解析器。不。托盘提供了查看流并从中消费字符的工具... 就这些。

托盘除了 Rust 标准库外没有其他依赖，整个代码库非常小巧。它甚至处理了 Windows 上的奇怪编码。

如果这些都听起来不错，那么欢迎加入！

托盘使用语义版本控制。

错误？

你是否发现了错误？通过托盘问题跟踪器提交错误，并确保包括（1）发生了什么，（2）你期望发生什么，（3）如何重现错误，以及（4）你正在使用的版本的托盘。

在线文档

仅适用于主分支

本地文档

如果你已本地构建了文档，则此链接将带您进入。

构建

您需要安装 Rust 2021 版本才能编译。编译应该相对简单。

$ cargo build
   Compiling trivet v2.0.0 (/home/Projects/trivet)
    Finished dev [unoptimized + debuginfo] target(s) in 0.14s

这将构建托盘库。

您可能想看看 etc/build.sh 和 etc\build.ps1。这些是运行 "pre-commit" 流程的小脚本（bash 和 powershell）。

托盘书籍

散热垫附有一本描述其使用的书籍。要构建这本书，你需要 mdBook 和 mdbook-linkcheck。你可以按照以下方式安装这些工具。

$ cargo install mdbook mdbook-linkcheck
    Updating crates.io index
  Downloaded mdbook v0.4.34
  Downloaded 1 crate (1.5 MB) in 0.95s
  ...
     Summary Successfully installed mdbook-linkcheck, mdbook!

安装完成后，你可以使用以下命令构建书籍。

$ mdbook build doc
2023-08-08 07:11:00 [INFO] (mdbook::book): Book building has started
2023-08-08 07:11:00 [INFO] (mdbook::book): Running the html backend
2023-08-08 07:11:00 [INFO] (mdbook::book): Running the linkcheck backend
2023-08-08 07:11:00 [INFO] (mdbook::renderer): Invoking the "linkcheck" renderer

你也可以使用以下方式在任意更改时自动重建书籍。

$ mdbook serve doc
2023-08-08 07:11:23 [INFO] (mdbook::book): Book building has started
2023-08-08 07:11:23 [INFO] (mdbook::book): Running the html backend
...
2023-08-08 07:11:23 [INFO] (warp::server): listening on http://127.0.0.1:3000

API 文档

如果你需要文档，请运行以下命令：cargo doc --no-deps。

生成后，API 文档应该可以在本地从以下位置访问：target/doc/trivet/index.html。

安全

请使用问题跟踪器中问题描述字段下方的“此问题属机密”按钮提交敏感安全相关问题。

应定期将代码与已知的 Rust 安全通告进行比对。可以使用 cargo audit 进行此操作。你可以使用 cargo install cargo-audit 安装它。

考虑安装 Trivy。这是一个漏洞扫描器。

贡献

有关如何为该项目做出贡献的信息，请参阅贡献指南。

如果你有兴趣贡献，请参阅路线图、技术债务，以及代码中的任何 TODO 或 BUG 注释，以了解仍需完成的事情。其他人可能正在处理它们，所以请确保与项目保持联系。

trivet