<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>src/tools/rustfmt/README.md - fork/rust @ master</title>
<meta name="description" content="src/tools/rustfmt/README.md in fork/rust at master.">
<meta property="og:title" content="src/tools/rustfmt/README.md - fork/rust @ master">
<meta property="og:description" content="src/tools/rustfmt/README.md in fork/rust at master.">
<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="master" data-tip="3bcad65fbf67b6edf87c949531fbc13435882e6b">
<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/rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="3bcad65fbf67b6edf87c949531fbc13435882e6b">Auto merge of #103046 - JanBeh:PR_clarify_cmp_terminology, r=workingjubilee</span><span class="snapshot-sha sha" data-commit="3bcad65fbf67b6edf87c949531fbc13435882e6b">3bcad65fbf6</span><time datetime="2023-10-05T15:24:54+00:00" title="2023-10-05 15:24:54 +0000">2023-10-05</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/rust/ref/master/">master</a><strong>tags</strong><a href="/fork/rust/ref/1.39.0/">1.39.0</a><a href="/fork/rust/ref/1.40.0/">1.40.0</a><a href="/fork/rust/ref/1.41.0/">1.41.0</a><a href="/fork/rust/ref/1.41.1/">1.41.1</a><a href="/fork/rust/ref/1.42.0/">1.42.0</a><a href="/fork/rust/ref/1.43.0/">1.43.0</a><a href="/fork/rust/ref/1.43.1/">1.43.1</a><a href="/fork/rust/ref/1.44.0/">1.44.0</a><a class="all" href="/fork/rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rust/">rust</a> / <a href="/fork/rust/ref/master/tree/src/">src</a> / <a href="/fork/rust/ref/master/tree/src/tools/">tools</a> / <a href="/fork/rust/ref/master/tree/src/tools/rustfmt/">rustfmt</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>9.0 KiB</span><span>232 lines</span></span><span class="actions"><a class="raw" href="/fork/rust/raw/c05184fbb04b8481279d5ebeb7681895af464124/src/tools/rustfmt/README.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>rustfmt <a href="https://github.com/rust-lang/rustfmt/actions/workflows/linux.yml"><img src="https://github.com/rust-lang/rustfmt/actions/workflows/linux.yml/badge.svg?event=push" alt="linux" /></a> <a href="https://github.com/rust-lang/rustfmt/actions/workflows/mac.yml"><img src="https://github.com/rust-lang/rustfmt/actions/workflows/mac.yml/badge.svg?event=push" alt="mac" /></a> <a href="https://github.com/rust-lang/rustfmt/actions/workflows/windows.yml"><img src="https://github.com/rust-lang/rustfmt/actions/workflows/windows.yml/badge.svg?event=push" alt="windows" /></a> <a href="https://crates.io/crates/rustfmt-nightly"><img src="https://img.shields.io/crates/v/rustfmt-nightly.svg" alt="crates.io" /></a></h1>
<p>A tool for formatting Rust code according to style guidelines.</p>
<p>If you'd like to help out (and you should, it's a fun project!), see
<a href="/fork/rust/ref/master/blob/src/tools/rustfmt/Contributing.md">Contributing.md</a> and our <a href="/fork/rust/ref/master/blob/src/tools/rustfmt/CODE_OF_CONDUCT.md">Code of
Conduct</a>.</p>
<p>You can use rustfmt in Travis CI builds. We provide a minimal Travis CI
configuration (see <a href="#checking-style-on-a-ci-server">here</a>).</p>
<h2>Quick start</h2>
<p>You can run <code>rustfmt</code> with Rust 1.24 and above.</p>
<h3>On the Stable toolchain</h3>
<p>To install:</p>
<pre class="language-bash"><a-f>rustup</a-f> component add rustfmt</pre>
<p>To run on a cargo project in the current working directory:</p>
<pre class="language-bash"><a-f>cargo</a-f> fmt</pre>
<h3>On the Nightly toolchain</h3>
<p>For the latest and greatest <code>rustfmt</code>, nightly is required.</p>
<p>To install:</p>
<pre class="language-bash"><a-f>rustup</a-f> component add rustfmt <a-co>--toolchain</a-co> nightly</pre>
<p>To run on a cargo project in the current working directory:</p>
<pre class="language-bash"><a-f>cargo</a-f> +nightly fmt</pre>
<h2>Limitations</h2>
<p>Rustfmt tries to work on as much Rust code as possible. Sometimes, the code
doesn't even need to compile! In general, we are looking to limit areas of
instability; in particular, post-1.0, the formatting of most code should not
change as Rustfmt improves. However, there are some things that Rustfmt can't
do or can't do well (and thus where formatting might change significantly,
even post-1.0). We would like to reduce the list of limitations over time.</p>
<p>The following list enumerates areas where Rustfmt does not work or where the
stability guarantees do not apply (we don't make a distinction between the two
because in the future Rustfmt might work on code where it currently does not):</p>
<ul>
<li>a program where any part of the program does not parse (parsing is an early
stage of compilation and in Rust includes macro expansion).</li>
<li>Macro declarations and uses (current status: some macro declarations and uses
are formatted).</li>
<li>Comments, including any AST node with a comment 'inside' (Rustfmt does not
currently attempt to format comments, it does format code with comments inside, but that formatting may change in the future).</li>
<li>Rust code in code blocks in comments.</li>
<li>Any fragment of a program (i.e., stability guarantees only apply to whole
programs, even where fragments of a program can be formatted today).</li>
<li>Code containing non-ascii unicode characters (we believe Rustfmt mostly works
here, but do not have the test coverage or experience to be 100% sure).</li>
<li>Bugs in Rustfmt (like any software, Rustfmt has bugs, we do not consider bug
fixes to break our stability guarantees).</li>
</ul>
<h2>Running</h2>
<p>You can run Rustfmt by just typing <code>rustfmt filename</code> if you used <code>cargo install</code>. This runs rustfmt on the given file, if the file includes out of line
modules, then we reformat those too. So to run on a whole module or crate, you
just need to run on the root file (usually mod.rs or lib.rs). Rustfmt can also
read data from stdin. Alternatively, you can use <code>cargo fmt</code> to format all
binary and library targets of your crate.</p>
<p>You can run <code>rustfmt --help</code> for information about available arguments.
The easiest way to run rustfmt against a project is with <code>cargo fmt</code>. <code>cargo fmt</code> works on both
single-crate projects and <a href="https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html">cargo workspaces</a>.
Please see <code>cargo fmt --help</code> for usage information.</p>
<p>You can specify the path to your own <code>rustfmt</code> binary for cargo to use by setting the<code>RUSTFMT</code>
environment variable. This was added in v1.4.22, so you must have this version or newer to leverage this feature (<code>cargo fmt --version</code>)</p>
<h3>Running <code>rustfmt</code> directly</h3>
<p>To format individual files or arbitrary codes from stdin, the <code>rustfmt</code> binary should be used. Some
examples follow:</p>
<ul>
<li><code>rustfmt lib.rs main.rs</code> will format "lib.rs" and "main.rs" in place</li>
<li><code>rustfmt</code> will read a code from stdin and write formatting to stdout
<ul>
<li><code>echo "fn     main() {}" | rustfmt</code> would emit "fn main() {}".</li>
</ul>
</li>
</ul>
<p>For more information, including arguments and emit options, see <code>rustfmt --help</code>.</p>
<h3>Verifying code is formatted</h3>
<p>When running with <code>--check</code>, Rustfmt will exit with <code>0</code> if Rustfmt would not
make any formatting changes to the input, and <code>1</code> if Rustfmt would make changes.
In other modes, Rustfmt will exit with <code>1</code> if there was some error during
formatting (for example a parsing or internal error) and <code>0</code> if formatting
completed without error (whether or not changes were made).</p>
<h2>Running Rustfmt from your editor</h2>
<ul>
<li><a href="https://github.com/rust-lang/rust.vim#formatting-with-rustfmt">Vim</a></li>
<li><a href="https://github.com/rust-lang/rust-mode">Emacs</a></li>
<li><a href="https://packagecontrol.io/packages/RustFmt">Sublime Text 3</a></li>
<li><a href="/fork/rust/ref/master/blob/src/tools/rustfmt/atom.md">Atom</a></li>
<li><a href="https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer">Visual Studio Code</a></li>
<li><a href="/fork/rust/ref/master/blob/src/tools/rustfmt/intellij.md">IntelliJ or CLion</a></li>
</ul>
<h2>Checking style on a CI server</h2>
<p>To keep your code base consistently formatted, it can be helpful to fail the CI build
when a pull request contains unformatted code. Using <code>--check</code> instructs
rustfmt to exit with an error code if the input is not formatted correctly.
It will also print any found differences. (Older versions of Rustfmt don't
support <code>--check</code>, use <code>--write-mode diff</code>).</p>
<p>A minimal Travis setup could look like this (requires Rust 1.31.0 or greater):</p>
<pre class="language-yaml"><a-pr>language</a-pr><a-p>:</a-p> <a-s>rust</a-s>
<a-pr>before_script</a-pr><a-p>:</a-p>
<a-p>-</a-p> <a-s>rustup component add rustfmt</a-s>
<a-pr>script</a-pr><a-p>:</a-p>
<a-p>-</a-p> <a-s>cargo build</a-s>
<a-p>-</a-p> <a-s>cargo test</a-s>
<a-p>-</a-p> <a-s>cargo fmt --all -- --check</a-s></pre>
<p>See <a href="https://medium.com/@ag_dubs/enforcing-style-in-ci-for-rust-projects-18f6b09ec69d">this blog post</a>
for more info.</p>
<h2>How to build and test</h2>
<p><code>cargo build</code> to build.</p>
<p><code>cargo test</code> to run all tests.</p>
<p>To run rustfmt after this, use <code>cargo run --bin rustfmt -- filename</code>. See the
notes above on running rustfmt.</p>
<h2>Configuring Rustfmt</h2>
<p>Rustfmt is designed to be very configurable. You can create a TOML file called
<code>rustfmt.toml</code> or <code>.rustfmt.toml</code>, place it in the project or any other parent
directory and it will apply the options in that file. See <code>rustfmt --help=config</code> for the options which are available, or if you prefer to see
visual style previews, <a href="https://rust-lang.github.io/rustfmt/">GitHub page</a>.</p>
<p>By default, Rustfmt uses a style which conforms to the <a href="https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md">Rust style guide</a> that has been formalized through the <a href="https://github.com/rust-dev-tools/fmt-rfcs">style RFC
process</a>.</p>
<p>Configuration options are either stable or unstable. Stable options can always
be used, while unstable ones are only available on a nightly toolchain, and opt-in.
See <a href="https://rust-lang.github.io/rustfmt/">GitHub page</a> for details.</p>
<h3>Rust's Editions</h3>
<p>Rustfmt is able to pick up the edition used by reading the <code>Cargo.toml</code> file if
executed through the Cargo's formatting tool <code>cargo fmt</code>. Otherwise, the edition
needs to be specified in <code>rustfmt.toml</code>, e.g., with <code>edition = "2018"</code>.</p>
<h2>Tips</h2>
<ul>
<li>
<p>For things you do not want rustfmt to mangle, use <code>#[rustfmt::skip]</code></p>
</li>
<li>
<p>To prevent rustfmt from formatting a macro or an attribute,
use <code>#[rustfmt::skip::macros(target_macro_name)]</code> or
<code>#[rustfmt::skip::attributes(target_attribute_name)]</code></p>
<p>Example:</p>
<pre class="language-rust"><a-at>#!</a-at><a-p>[</a-p><a-at>rustfmt</a-at><a-p>::</a-p><a-at>skip</a-at><a-p>::</a-p><a-at>attributes</a-at><a-p>(</a-p><a-at>custom_attribute</a-at><a-p>)]</a-p>

<a-at>#</a-at><a-p>[</a-p><a-at>custom_attribute</a-at><a-p>(</a-p><a-at>formatting </a-at><a-p>,</a-p><a-at> here </a-at><a-p>,</a-p><a-at> should </a-at><a-p>,</a-p><a-at> be </a-at><a-p>,</a-p><a-at> </a-at><a-cr>Skipped</a-cr><a-p>)]</a-p>
<a-at>#</a-at><a-p>[</a-p><a-at>rustfmt</a-at><a-p>::</a-p><a-at>skip</a-at><a-p>::</a-p><a-at>macros</a-at><a-p>(</a-p><a-at>html</a-at><a-p>)]</a-p>
<a-k>fn</a-k> main<a-p>()</a-p> <a-p>{</a-p>
    <a-k>let</a-k> macro_result1 = <a-m>html!</a-m> <a-p>{</a-p> &lt;<a-t>div</a-t>&gt;
<a-cr>Hello</a-cr>&lt;/div&gt;
    <a-p>}.</a-p><a-f>to_string</a-f><a-p>();</a-p></pre>
</li>
<li>
<p>When you run rustfmt, place a file named <code>rustfmt.toml</code> or <code>.rustfmt.toml</code> in
target file directory or its parents to override the default settings of
rustfmt. You can generate a file containing the default configuration with
<code>rustfmt --print-config default rustfmt.toml</code> and customize as needed.</p>
</li>
<li>
<p>After successful compilation, a <code>rustfmt</code> executable can be found in the
target directory.</p>
</li>
<li>
<p>If you're having issues compiling Rustfmt (or compile errors when trying to
install), make sure you have the most recent version of Rust installed.</p>
</li>
<li>
<p>You can change the way rustfmt emits the changes with the --emit flag:</p>
<p>Example:</p>
<pre class="language-bash"><a-f>cargo</a-f> fmt <a-co>--</a-co> <a-co>--emit</a-co> files</pre>
<p>Options:</p>
<table><thead><tr><th style="text-align: center">Flag</th><th style="text-align: center">Description</th><th style="text-align: center">Nightly Only</th></tr></thead><tbody>
<tr><td style="text-align: center">files</td><td style="text-align: center">overwrites output to files</td><td style="text-align: center">No</td></tr>
<tr><td style="text-align: center">stdout</td><td style="text-align: center">writes output to stdout</td><td style="text-align: center">No</td></tr>
<tr><td style="text-align: center">coverage</td><td style="text-align: center">displays how much of the input file was processed</td><td style="text-align: center">Yes</td></tr>
<tr><td style="text-align: center">checkstyle</td><td style="text-align: center">emits in a checkstyle format</td><td style="text-align: center">Yes</td></tr>
<tr><td style="text-align: center">json</td><td style="text-align: center">emits diffs in a json format</td><td style="text-align: center">Yes</td></tr>
</tbody></table>
</li>
</ul>
<h2>License</h2>
<p>Rustfmt is distributed under the terms of both the MIT license and the
Apache License (Version 2.0).</p>
<p>See <a href="/fork/rust/ref/master/blob/src/tools/rustfmt/LICENSE-APACHE">LICENSE-APACHE</a> and <a href="/fork/rust/ref/master/blob/src/tools/rustfmt/LICENSE-MIT">LICENSE-MIT</a> for details.</p>
</section><div class="code-panel"><pre class="code src" data-hl="src/tools/rustfmt/README.md"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"># rustfmt [![linux](https://github.com/rust-lang/rustfmt/actions/workflows/linux.yml/badge.svg?event=push)](https://github.com/rust-lang/rustfmt/actions/workflows/linux.yml) [![mac](https://github.com/rust-lang/rustfmt/actions/workflows/mac.yml/badge.svg?event=push)](https://github.com/rust-lang/rustfmt/actions/workflows/mac.yml) [![windows](https://github.com/rust-lang/rustfmt/actions/workflows/windows.yml/badge.svg?event=push)](https://github.com/rust-lang/rustfmt/actions/workflows/windows.yml) [![crates.io](https://img.shields.io/crates/v/rustfmt-nightly.svg)](https://crates.io/crates/rustfmt-nightly)</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">A tool for formatting Rust code according to style guidelines.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">If you'd like to help out (and you should, it's a fun project!), see</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">[Contributing.md](Contributing.md) and our [Code of</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">Conduct](CODE_OF_CONDUCT.md).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">You can use rustfmt in Travis CI builds. We provide a minimal Travis CI</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">configuration (see [here](#checking-style-on-a-ci-server)).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">## Quick start</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">You can run `rustfmt` with Rust 1.24 and above.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">### On the Stable toolchain</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">To install:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">```sh</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">rustup component add rustfmt</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">To run on a cargo project in the current working directory:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">```sh</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">cargo fmt</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">### On the Nightly toolchain</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text">For the latest and greatest `rustfmt`, nightly is required.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text">To install:</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">```sh</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text">rustup component add rustfmt --toolchain nightly</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text">To run on a cargo project in the current working directory:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text">```sh</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text">cargo +nightly fmt</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text">```</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">## Limitations</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text">Rustfmt tries to work on as much Rust code as possible. Sometimes, the code</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text">doesn't even need to compile! In general, we are looking to limit areas of</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text">instability; in particular, post-1.0, the formatting of most code should not</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text">change as Rustfmt improves. However, there are some things that Rustfmt can't</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text">do or can't do well (and thus where formatting might change significantly,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text">even post-1.0). We would like to reduce the list of limitations over time.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text">The following list enumerates areas where Rustfmt does not work or where the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text">stability guarantees do not apply (we don't make a distinction between the two</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text">because in the future Rustfmt might work on code where it currently does not):</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"></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 program where any part of the program does not parse (parsing is an early</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text">  stage of compilation and in Rust includes macro expansion).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text">* Macro declarations and uses (current status: some macro declarations and uses</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text">  are formatted).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text">* Comments, including any AST node with a comment 'inside' (Rustfmt does not</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text">  currently attempt to format comments, it does format code with comments inside, but that formatting may change in the future).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text">* Rust code in code blocks in comments.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text">* Any fragment of a program (i.e., stability guarantees only apply to whole</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text">  programs, even where fragments of a program can be formatted today).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text">* Code containing non-ascii unicode characters (we believe Rustfmt mostly works</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text">  here, but do not have the test coverage or experience to be 100% sure).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text">* Bugs in Rustfmt (like any software, Rustfmt has bugs, we do not consider bug</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text">  fixes to break our stability guarantees).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text">## Running</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text">You can run Rustfmt by just typing `rustfmt filename` if you used `cargo</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text">install`. This runs rustfmt on the given file, if the file includes out of line</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text">modules, then we reformat those too. So to run on a whole module or crate, you</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text">just need to run on the root file (usually mod.rs or lib.rs). Rustfmt can also</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text">read data from stdin. Alternatively, you can use `cargo fmt` to format all</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text">binary and library targets of your crate.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text">You can run `rustfmt --help` for information about available arguments.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text">The easiest way to run rustfmt against a project is with `cargo fmt`. `cargo fmt` works on both</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text">single-crate projects and [cargo workspaces](https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text">Please see `cargo fmt --help` for usage information.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text">You can specify the path to your own `rustfmt` binary for cargo to use by setting the`RUSTFMT` </span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text">environment variable. This was added in v1.4.22, so you must have this version or newer to leverage this feature (`cargo fmt --version`)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text">### Running `rustfmt` directly</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text">To format individual files or arbitrary codes from stdin, the `rustfmt` binary should be used. Some</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text">examples follow:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text">- `rustfmt lib.rs main.rs` will format &quot;lib.rs&quot; and &quot;main.rs&quot; in place</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text">- `rustfmt` will read a code from stdin and write formatting to stdout</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text">  - `echo &quot;fn     main() {}&quot; | rustfmt` would emit &quot;fn main() {}&quot;.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text">For more information, including arguments and emit options, see `rustfmt --help`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text">### Verifying code is formatted</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text">When running with `--check`, Rustfmt will exit with `0` if Rustfmt would not</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text">make any formatting changes to the input, and `1` if Rustfmt would make changes.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text">In other modes, Rustfmt will exit with `1` if there was some error during</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text">formatting (for example a parsing or internal error) and `0` if formatting</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text">completed without error (whether or not changes were made).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text">## Running Rustfmt from your editor</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text">* [Vim](https://github.com/rust-lang/rust.vim#formatting-with-rustfmt)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text">* [Emacs](https://github.com/rust-lang/rust-mode)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text">* [Sublime Text 3](https://packagecontrol.io/packages/RustFmt)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text">* [Atom](atom.md)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text">* [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text">* [IntelliJ or CLion](intellij.md)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text">## Checking style on a CI server</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text">To keep your code base consistently formatted, it can be helpful to fail the CI build</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text">when a pull request contains unformatted code. Using `--check` instructs</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text">rustfmt to exit with an error code if the input is not formatted correctly.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text">It will also print any found differences. (Older versions of Rustfmt don't</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text">support `--check`, use `--write-mode diff`).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text">A minimal Travis setup could look like this (requires Rust 1.31.0 or greater):</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text">```yaml</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text">language: rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text">before_script:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text">- rustup component add rustfmt</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text">script:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text">- cargo build</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text">- cargo test</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text">- cargo fmt --all -- --check</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text">See [this blog post](https://medium.com/@ag_dubs/enforcing-style-in-ci-for-rust-projects-18f6b09ec69d)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text">for more info.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text">## How to build and test</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text">`cargo build` to build.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text">`cargo test` to run all tests.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text">To run rustfmt after this, use `cargo run --bin rustfmt -- filename`. See the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text">notes above on running rustfmt.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text">## Configuring Rustfmt</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text">Rustfmt is designed to be very configurable. You can create a TOML file called</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text">`rustfmt.toml` or `.rustfmt.toml`, place it in the project or any other parent</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text">directory and it will apply the options in that file. See `rustfmt</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text">--help=config` for the options which are available, or if you prefer to see</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text">visual style previews, [GitHub page](https://rust-lang.github.io/rustfmt/).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text">By default, Rustfmt uses a style which conforms to the [Rust style guide][style</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text">guide] that has been formalized through the [style RFC</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text">process][fmt rfcs].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text">Configuration options are either stable or unstable. Stable options can always</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text">be used, while unstable ones are only available on a nightly toolchain, and opt-in.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text">See [GitHub page](https://rust-lang.github.io/rustfmt/) for details.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text">### Rust's Editions</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text">Rustfmt is able to pick up the edition used by reading the `Cargo.toml` file if</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text">executed through the Cargo's formatting tool `cargo fmt`. Otherwise, the edition</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text">needs to be specified in `rustfmt.toml`, e.g., with `edition = &quot;2018&quot;`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text">## Tips</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text">* For things you do not want rustfmt to mangle, use `#[rustfmt::skip]`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L180" href="#L180">180</a><span class="code-text">* To prevent rustfmt from formatting a macro or an attribute,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text">  use `#[rustfmt::skip::macros(target_macro_name)]` or</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</a><span class="code-text">  `#[rustfmt::skip::attributes(target_attribute_name)]`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text">  Example:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L186" href="#L186">186</a><span class="code-text">    ```rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L187" href="#L187">187</a><span class="code-text">    #![rustfmt::skip::attributes(custom_attribute)]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text">    #[custom_attribute(formatting , here , should , be , Skipped)]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text">    #[rustfmt::skip::macros(html)]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L191" href="#L191">191</a><span class="code-text">    fn main() {</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L192" href="#L192">192</a><span class="code-text">        let macro_result1 = html! { &lt;div&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text">    Hello&lt;/div&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L194" href="#L194">194</a><span class="code-text">        }.to_string();</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L195" href="#L195">195</a><span class="code-text">    ```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L196" href="#L196">196</a><span class="code-text">* When you run rustfmt, place a file named `rustfmt.toml` or `.rustfmt.toml` in</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L197" href="#L197">197</a><span class="code-text">  target file directory or its parents to override the default settings of</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L198" href="#L198">198</a><span class="code-text">  rustfmt. You can generate a file containing the default configuration with</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L199" href="#L199">199</a><span class="code-text">  `rustfmt --print-config default rustfmt.toml` and customize as needed.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L200" href="#L200">200</a><span class="code-text">* After successful compilation, a `rustfmt` executable can be found in the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L201" href="#L201">201</a><span class="code-text">  target directory.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L202" href="#L202">202</a><span class="code-text">* If you're having issues compiling Rustfmt (or compile errors when trying to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L203" href="#L203">203</a><span class="code-text">  install), make sure you have the most recent version of Rust installed.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L204" href="#L204">204</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L205" href="#L205">205</a><span class="code-text">* You can change the way rustfmt emits the changes with the --emit flag:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L206" href="#L206">206</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L207" href="#L207">207</a><span class="code-text">  Example:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L208" href="#L208">208</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L209" href="#L209">209</a><span class="code-text">  ```sh</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L210" href="#L210">210</a><span class="code-text">  cargo fmt -- --emit files</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L211" href="#L211">211</a><span class="code-text">  ```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L212" href="#L212">212</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L213" href="#L213">213</a><span class="code-text">  Options:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L214" href="#L214">214</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L215" href="#L215">215</a><span class="code-text">  | Flag |Description| Nightly Only |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L216" href="#L216">216</a><span class="code-text">  |:---:|:---:|:---:|</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L217" href="#L217">217</a><span class="code-text">  | files | overwrites output to files | No |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L218" href="#L218">218</a><span class="code-text">  | stdout | writes output to stdout | No |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L219" href="#L219">219</a><span class="code-text">  | coverage | displays how much of the input file was processed | Yes |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L220" href="#L220">220</a><span class="code-text">  | checkstyle | emits in a checkstyle format | Yes |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L221" href="#L221">221</a><span class="code-text">  | json | emits diffs in a json format | Yes |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L222" href="#L222">222</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L223" href="#L223">223</a><span class="code-text">## License</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L224" href="#L224">224</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L225" href="#L225">225</a><span class="code-text">Rustfmt is distributed under the terms of both the MIT license and the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L226" href="#L226">226</a><span class="code-text">Apache License (Version 2.0).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L227" href="#L227">227</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L228" href="#L228">228</a><span class="code-text">See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L229" href="#L229">229</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L230" href="#L230">230</a><span class="code-text">[rust]: https://github.com/rust-lang/rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L231" href="#L231">231</a><span class="code-text">[fmt rfcs]: https://github.com/rust-dev-tools/fmt-rfcs</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L232" href="#L232">232</a><span class="code-text">[style guide]: https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md</span></span></pre></div></div>
</main>
</body>
</html>
