Rust项目推荐的目录结构是什么？

Question

应该在哪里放置源代码，示例，文档，单元测试，集成测试，许可证，基准测试等？

Answer 1

货物，生锈，defines some conventions regarding the layout of a Rust crate官方包管理器：

. 
├── Cargo.lock 
├── Cargo.toml 
├── benches 
│ └── large-input.rs 
├── examples 
│ └── simple.rs 
├── src 
│ ├── bin 
│ │ └── another_executable.rs 
│ ├── lib.rs 
│ └── main.rs 
└── tests 
    └── some-integration-tests.rs 

• Cargo.toml和Cargo.lock存储在您的项目的根。
• 源代码出现在src目录中。
• 默认库文件是src/lib.rs。
• 默认的可执行文件是src/main.rs。
• 其他可执行文件可以放在src/bin/*.rs。
• 集成测试进入tests目录（单元测试放在他们测试的每个文件中）。
• 示例可执行文件进入examples目录。
• 基准进入benches目录。

这些在manifest description中有更详细的解释。

通过遵循此标准布局，您将能够使用Cargo的命令轻松地构建，运行和测试您的项目。运行cargo new以设置新的库项目或cargo new --bin以设置新的可执行项目。

此外，库的文档通常写入文档注释（在任何项目之前以///开始的注释或以文档形式记录父项目的//!）。此外，许可证通常放在根部。

如上所述，单元测试与它们正在测试的功能在同一模块中编写。通常，他们被放在一个内部模块中。它看起来像这样（这是什么货物生成一个新的图书馆与cargo new）：

#[cfg(test)] 
mod tests { 
    #[test] 
    fn it_works() { 
    } 
}