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() { 
    } 
}