<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>src/doc/src/guide/project-layout.md - fork/cargo @ 0.87.0</title>
<meta name="description" content="src/doc/src/guide/project-layout.md in fork/cargo at 0.87.0.">
<meta property="og:title" content="src/doc/src/guide/project-layout.md - fork/cargo @ 0.87.0">
<meta property="og:description" content="src/doc/src/guide/project-layout.md in fork/cargo at 0.87.0.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="0.87.0" data-tip="adf9b6ad14cfa10ff680d5806741a144f7163698">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/cargo</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/cargo</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="d619310a1dd66d1e1a1cdb1aeb67d06dccd0e003">Auto merge of #12595 - weihanglo:doc-headings, r=epage</span><span class="snapshot-sha sha" data-commit="d619310a1dd66d1e1a1cdb1aeb67d06dccd0e003">d619310a1</span><time datetime="2023-09-01T15:50:41+00:00" title="2023-09-01 15:50:41 +0000">2023-09-01</time></p>
<header class="topbar"><details class="switcher"><summary>0.87.0</summary><div class="menu"><strong>branches</strong><a href="/fork/cargo/ref/master/">master</a><strong>tags</strong><a class="current" href="/fork/cargo/ref/0.87.0/">0.87.0</a><a href="/fork/cargo/ref/0.88.0/">0.88.0</a><a href="/fork/cargo/ref/0.89.0/">0.89.0</a><a href="/fork/cargo/ref/0.90.0/">0.90.0</a><a href="/fork/cargo/ref/0.91.0/">0.91.0</a><a href="/fork/cargo/ref/0.92.0/">0.92.0</a><a href="/fork/cargo/ref/0.93.0/">0.93.0</a><a href="/fork/cargo/ref/home-0.5.12/">home-0.5.12</a><a class="all" href="/fork/cargo/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/cargo/">cargo</a> / <a href="/fork/cargo/ref/0.87.0/tree/src/">src</a> / <a href="/fork/cargo/ref/0.87.0/tree/src/doc/">doc</a> / <a href="/fork/cargo/ref/0.87.0/tree/src/doc/src/">src</a> / <a href="/fork/cargo/ref/0.87.0/tree/src/doc/src/guide/">guide</a> / <span class="cur">project-layout.md</span></nav>
<span class="view-stats"><span>2.3 KiB</span><span>61 lines</span></span><span class="actions"><a class="raw" href="/fork/cargo/raw/c4360af019ce4dcaaa94df058956510f0738d0b3/src/doc/src/guide/project-layout.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Package Layout</h1>
<p>Cargo uses conventions for file placement to make it easy to dive into a new
Cargo <a href="/fork/cargo/ref/0.87.0/blob/src/doc/src/appendix/glossary.md#package" title="&quot;package&quot; (glossary entry)">package</a>:</p>
<pre>.
├── Cargo.lock
├── Cargo.toml
├── src/
│   ├── lib.rs
│   ├── main.rs
│   └── bin/
│       ├── named-executable.rs
│       ├── another-executable.rs
│       └── multi-file-executable/
│           ├── main.rs
│           └── some_module.rs
├── benches/
│   ├── large-input.rs
│   └── multi-file-bench/
│       ├── main.rs
│       └── bench_module.rs
├── examples/
│   ├── simple.rs
│   └── multi-file-example/
│       ├── main.rs
│       └── ex_module.rs
└── tests/
    ├── some-integration-tests.rs
    └── multi-file-test/
        ├── main.rs
        └── test_module.rs
</pre>
<ul>
<li><code>Cargo.toml</code> and <code>Cargo.lock</code> are stored in the root of your package (<em>package
root</em>).</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>.
<ul>
<li>Other executables can be placed in <code>src/bin/</code>.</li>
</ul>
</li>
<li>Benchmarks go in the <code>benches</code> directory.</li>
<li>Examples go in the <code>examples</code> directory.</li>
<li>Integration tests go in the <code>tests</code> directory.</li>
</ul>
<p>If a binary, example, bench, or integration test consists of multiple source
files, place a <code>main.rs</code> file along with the extra <a href="/fork/cargo/ref/0.87.0/blob/src/doc/src/appendix/glossary.md#module" title="&quot;module&quot; (glossary entry)"><em>modules</em></a>
within a subdirectory of the <code>src/bin</code>, <code>examples</code>, <code>benches</code>, or <code>tests</code>
directory. The name of the executable will be the directory name.</p>
<p>You can learn more about Rust's module system in <a href="../../book/ch07-00-managing-growing-projects-with-packages-crates-and-modules.html">the book</a>.</p>
<p>See <a href="/fork/cargo/ref/0.87.0/blob/src/doc/src/reference/cargo-targets.md#configuring-a-target">Configuring a target</a> for more details on manually configuring targets.
See <a href="/fork/cargo/ref/0.87.0/blob/src/doc/src/reference/cargo-targets.md#target-auto-discovery">Target auto-discovery</a> for more information on controlling how Cargo
automatically infers target names.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Package Layout</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">Cargo uses conventions for file placement to make it easy to dive into a new</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">Cargo [package][def-package]:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>```</a-p><a-tl>text</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>├── Cargo.lock</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>├── Cargo.toml</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>├── src/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>│   ├── lib.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>│   ├── main.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>│   └── bin/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>│       ├── named-executable.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>│       ├── another-executable.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>│       └── multi-file-executable/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>│           ├── main.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>│           └── some_module.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>├── benches/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>│   ├── large-input.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>│   └── multi-file-bench/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>│       ├── main.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>│       └── bench_module.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>├── examples/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>│   ├── simple.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>│   └── multi-file-example/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>│       ├── main.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>│       └── ex_module.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>└── tests/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>    ├── some-integration-tests.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>    └── multi-file-test/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>        ├── main.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>        └── test_module.rs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>* `Cargo.toml` and `Cargo.lock` are stored in the root of your package (*package</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>  root*).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>* Source code goes in the `src` directory.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>* The default library file is `src/lib.rs`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>* The default executable file is `src/main.rs`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>    * Other executables can be placed in `src/bin/`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>* Benchmarks go in the `benches` directory.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>* Examples go in the `examples` directory.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>* Integration tests go in the `tests` directory.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>If a binary, example, bench, or integration test consists of multiple source</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>files, place a `main.rs` file along with the extra [*modules*][def-module]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>within a subdirectory of the `src/bin`, `examples`, `benches`, or `tests`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>directory. The name of the executable will be the directory name.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>You can learn more about Rust&#39;s module system in [the book][book-modules].</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>See [Configuring a target] for more details on manually configuring targets.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>See [Target auto-discovery] for more information on controlling how Cargo</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>automatically infers target names.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-tu>[book-modules]</a-tu><a-p>: </a-p><a-tu>../../book/ch07-00-managing-growing-projects-with-packages-crates-and-modules.html</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-tu>[Configuring a target]</a-tu><a-p>: </a-p><a-tu>../reference/cargo-targets.md#configuring-a-target</a-tu></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-tu>[def-package]</a-tu><a-p>:           </a-p><a-tu>../appendix/glossary.md#package</a-tu><a-p>          </a-p><a-tl>&#39;&quot;package&quot; (glossary entry)&#39;</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-tu>[def-module]</a-tu><a-p>:            </a-p><a-tu>../appendix/glossary.md#module</a-tu><a-p>           </a-p><a-tl>&#39;&quot;module&quot; (glossary entry)&#39;</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-tu>[Target auto-discovery]</a-tu><a-p>: </a-p><a-tu>../reference/cargo-targets.md#target-auto-discovery</a-tu></span></span></pre></div></div>
</main>
</body>
</html>
