blocks|key|112447|text|Cargo，Rust的官方包管理器，defines+some+conventions+regarding+the+layout+of+a+Rust+crate|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|112448|112449|。Cargo.lock+Cargo.toml+simple.rs├──│└──lib.rs+main.rs├──│└──├──│└──lib.rs-│├──-││└──│├──│└──│├──││└──│├──│└──│└──├──-│└──-├──-│├──.rs├──│└──├──│└──lib.rs│├──src││└──bin│├──│└──└──│├──││└──│├──│└──-├──-│├──s.rs|blockquote|112450|112451|112452|112453|Cargo.toml和测试存储在project.|unordered-list-item|style|CODE|112454|Source代码的根目录中directory.|112455|The默认库文件是src/lib.rs.|112456|The默认可执行文件是src/main.rs.|112457|Other可执行文件可以放在src/bin/*.rs.|112458|Integration测试中放在tests目录中(单元测试放在每个文件中它们是examples+directory.|112459|Benchmarks中的Cargo.lock可执行文件进入benches目录。|112460|112461|这些在manifest+description中有更详细的解释。|112462|通过遵循这个标准布局，您将能够使用Cargo的命令轻松地构建、运行和测试您的项目。运行cargo+new以设置新的可执行项目，或运行cargo+new+--lib以设置新的库项目。|112463|此外，库的文档通常写在文档注释中(在任何项目之前以///开头的注释，或以//!开头的注释，用于记录父项目)。此外，许可证通常放在根目录下。|112464|如上所述，单元测试是在与它们测试的函数相同的模块中编写的。通常，它们被放在一个内部模块中。它看起来像这样(这是Cargo使用cargo+new+--lib为新库生成的代码)：|112465|#[cfg(test)]
mod+tests+{
++++#[test]
++++fn+it_works()+{
++++}
}|code-block|syntax|javascript|112466|entityMap|0|LINK|mutability|MUTABLE|url|https://doc.rust-lang.org/stable/cargo/guide/project-layout.html|1|https://doc.rust-lang.org/stable/cargo/reference/manifest.html#the-project-layout^0|I|1P|0|0|0|0|0|0|0|0|A|0|0|9|A|0|B|B|0|E|C|0|G|5|13|8|0|C|A|T|7|0|0|3|K|1|0|17|9|1U|F|0|P|3|10|3|0|1Q|F|0|0^^$0|@$1|2|3|4|5|6|7|1P|8|@]|9|@$A|1Q|B|1R|1|1S]]|C|$]]|$1|D|3|-4|5|6|7|1T|8|@]|9|@]|C|$]]|$1|E|3|F|5|G|7|1U|8|@]|9|@]|C|$]]|$1|H|3|-4|5|6|7|1V|8|@]|9|@]|C|$]]|$1|I|3|-4|5|6|7|1W|8|@]|9|@]|C|$]]|$1|J|3|-4|5|6|7|1X|8|@]|9|@]|C|$]]|$1|K|3|L|5|M|7|1Y|8|@$A|1Z|B|20|N|O]]|9|@]|C|$]]|$1|P|3|Q|5|M|7|21|8|@]|9|@]|C|$]]|$1|R|3|S|5|M|7|22|8|@$A|23|B|24|N|O]]|9|@]|C|$]]|$1|T|3|U|5|M|7|25|8|@$A|26|B|27|N|O]]|9|@]|C|$]]|$1|V|3|W|5|M|7|28|8|@$A|29|B|2A|N|O]]|9|@]|C|$]]|$1|X|3|Y|5|M|7|2B|8|@$A|2C|B|2D|N|O]|$A|2E|B|2F|N|O]]|9|@]|C|$]]|$1|Z|3|10|5|M|7|2G|8|@$A|2H|B|2I|N|O]|$A|2J|B|2K|N|O]]|9|@]|C|$]]|$1|11|3|-4|5|6|7|2L|8|@]|9|@]|C|$]]|$1|12|3|13|5|6|7|2M|8|@]|9|@$A|2N|B|2O|1|2P]]|C|$]]|$1|14|3|15|5|6|7|2Q|8|@$A|2R|B|2S|N|O]|$A|2T|B|2U|N|O]]|9|@]|C|$]]|$1|16|3|17|5|6|7|2V|8|@$A|2W|B|2X|N|O]|$A|2Y|B|2Z|N|O]]|9|@]|C|$]]|$1|18|3|19|5|6|7|30|8|@$A|31|B|32|N|O]]|9|@]|C|$]]|$1|1A|3|1B|5|1C|7|33|8|@]|9|@]|C|$1D|1E]]|$1|1F|3|-4|5|6|7|34|8|@]|9|@]|C|$]]]|1G|$1H|$5|1I|1J|1K|C|$1L|1M]]|1N|$5|1I|1J|1K|C|$1L|1O]]]]

Cargo, the official package manager for Rust, <a href="https://doc.rust-lang.org/stable/cargo/guide/project-layout.html" rel="noreferrer">defines some conventions regarding the layout of a Rust crate</a>:

<blockquote>
 <pre class="lang-none prettyprint-override"><code>.
├── 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
</code></pre>
 
 <ul>
 <li><code>Cargo.toml</code> and <code>Cargo.lock</code> are stored in the root of your project.</li>
 <li>Source code goes in the <code>src</code> directory.</li>
 <li>The default library file is <code>src/lib.rs</code>.</li>
 <li>The default executable file is <code>src/main.rs</code>.</li>
 <li>Other executables can be placed in <code>src/bin/*.rs</code>.</li>
 <li>Integration tests go in the <code>tests</code> directory (unit tests go in each file they're testing).</li>
 <li>Example executable files go in the <code>examples</code> directory.</li>
 <li>Benchmarks go in the <code>benches</code> directory.</li>
 </ul>
 
 These are explained in more detail in the <a href="https://doc.rust-lang.org/stable/cargo/reference/manifest.html#the-project-layout" rel="noreferrer">manifest description</a>.
</blockquote>

By following this standard layout, you'll be able to use Cargo's commands to build, run and test your project easily. Run <code>cargo new</code> to set up a new executable project or <code>cargo new --lib</code> to set up a new library project.

Additionally, documentation for libraries is often written in documentation comments (comments that start with <code>///</code> before any item, or <code>//!</code> to document the parent item). Also, the license is usually put at the root.

Unit tests, as mentioned above, are written in the same module as the functions they're testing. Usually, they're put in an inner module. It looks like this (this is what Cargo generates for a new library with <code>cargo new --lib</code>):

<pre><code>#[cfg(test)]
mod tests {
 #[test]
 fn it_works() {
 }
}
</code></pre>

Where should one put the sources, examples, documentation, unit tests, integration tests, license, benchmarks etc?

What is the recommended directory structure for a Rust project?

单元测试

集成测试

包管理器

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

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

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

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

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

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