# Configuring Rustfmt
-Rustfmt is designed to be very configurable. You can create a TOML file called `rustfmt.toml` or `.rustfmt.toml`, place it in the project or any other parent directory and it will apply the options in that file.
+Rustfmt is designed to be very configurable. You can create a TOML file called `rustfmt.toml` or `.rustfmt.toml`, place it in the project or any other parent directory and it will apply the options in that file. If none of these directories contain such a file, both your home directory and a directory called `rustfmt` in your [global config directory](https://docs.rs/dirs/1.0.4/dirs/fn.config_dir.html) (e.g. `.config/rustfmt/`) are checked as well.
A possible content of `rustfmt.toml` or `.rustfmt.toml` might look like this:
Below you find a detailed visual guide on all the supported configuration options of rustfmt:
-## `indent_style`
-
-Indent on expressions or items.
+## `binop_separator`
-- **Default value**: `"Block"`
-- **Possible values**: `"Block"`, `"Visual"`
-- **Stable**: No
+Where to put a binary operator when a binary expression goes multiline.
-### Array
+- **Default value**: `"Front"`
+- **Possible values**: `"Front"`, `"Back"`
+- **Stable**: No (tracking issue: #3368)
-#### `"Block"` (default):
+#### `"Front"` (default):
```rust
fn main() {
- let lorem = vec![
- "ipsum",
- "dolor",
- "sit",
- "amet",
- "consectetur",
- "adipiscing",
- "elit",
- ];
-}
-```
+ let or = foofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoo
+ || barbarbarbarbarbarbarbarbarbarbarbarbarbarbarbar;
-#### `"Visual"`:
+ let sum = 123456789012345678901234567890
+ + 123456789012345678901234567890
+ + 123456789012345678901234567890;
-```rust
-fn main() {
- let lorem = vec!["ipsum",
- "dolor",
- "sit",
- "amet",
- "consectetur",
- "adipiscing",
- "elit"];
+ let range = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+ ..bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;
}
```
-### Control flow
-
-#### `"Block"` (default):
+#### `"Back"`:
```rust
fn main() {
- if lorem_ipsum
- && dolor_sit
- && amet_consectetur
- && lorem_sit
- && dolor_consectetur
- && amet_ipsum
- && lorem_consectetur
- {
- // ...
- }
-}
-```
+ let or = foofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoo ||
+ barbarbarbarbarbarbarbarbarbarbarbarbarbarbarbar;
-#### `"Visual"`:
+ let sum = 123456789012345678901234567890 +
+ 123456789012345678901234567890 +
+ 123456789012345678901234567890;
-```rust
-fn main() {
- if lorem_ipsum
- && dolor_sit
- && amet_consectetur
- && lorem_sit
- && dolor_consectetur
- && amet_ipsum
- && lorem_consectetur
- {
- // ...
- }
+ let range = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa..
+ bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;
}
```
-See also: [`control_brace_style`](#control_brace_style).
+## `blank_lines_lower_bound`
-### Function arguments
+Minimum number of blank lines which must be put between items. If two items have fewer blank lines between
+them, additional blank lines are inserted.
-#### `"Block"` (default):
+- **Default value**: `0`
+- **Possible values**: *unsigned integer*
+- **Stable**: No (tracking issue: #3382)
-```rust
-fn lorem() {}
+### Example
+Original Code (rustfmt will not change it with the default value of `0`):
-fn lorem(ipsum: usize) {}
+```rust
+#![rustfmt::skip]
-fn lorem(
- ipsum: usize,
- dolor: usize,
- sit: usize,
- amet: usize,
- consectetur: usize,
- adipiscing: usize,
- elit: usize,
-) {
- // body
+fn foo() {
+ println!("a");
+}
+fn bar() {
+ println!("b");
+ println!("c");
}
```
-#### `"Visual"`:
-
+#### `1`
```rust
-fn lorem() {}
-
-fn lorem(ipsum: usize) {}
+fn foo() {
-fn lorem(ipsum: usize,
- dolor: usize,
- sit: usize,
- amet: usize,
- consectetur: usize,
- adipiscing: usize,
- elit: usize) {
- // body
+ println!("a");
}
-```
-### Function calls
+fn bar() {
-#### `"Block"` (default):
+ println!("b");
-```rust
-fn main() {
- lorem(
- "lorem",
- "ipsum",
- "dolor",
- "sit",
- "amet",
- "consectetur",
- "adipiscing",
- "elit",
- );
+ println!("c");
}
```
-#### `"Visual"`:
-```rust
-fn main() {
- lorem("lorem",
- "ipsum",
- "dolor",
- "sit",
- "amet",
- "consectetur",
- "adipiscing",
- "elit");
-}
-```
+## `blank_lines_upper_bound`
-### Generics
+Maximum number of blank lines which can be put between items. If more than this number of consecutive empty
+lines are found, they are trimmed down to match this integer.
-#### `"Block"` (default):
+- **Default value**: `1`
+- **Possible values**: any non-negative integer
+- **Stable**: No (tracking issue: #3381)
+
+### Example
+Original Code:
```rust
-fn lorem<
- Ipsum: Eq = usize,
- Dolor: Eq = usize,
- Sit: Eq = usize,
- Amet: Eq = usize,
- Adipiscing: Eq = usize,
- Consectetur: Eq = usize,
- Elit: Eq = usize,
->(
- ipsum: Ipsum,
- dolor: Dolor,
- sit: Sit,
- amet: Amet,
- adipiscing: Adipiscing,
- consectetur: Consectetur,
- elit: Elit,
-) -> T {
- // body
+#![rustfmt::skip]
+
+fn foo() {
+ println!("a");
}
-```
-#### `"Visual"`:
-```rust
-fn lorem<Ipsum: Eq = usize,
- Dolor: Eq = usize,
- Sit: Eq = usize,
- Amet: Eq = usize,
- Adipiscing: Eq = usize,
- Consectetur: Eq = usize,
- Elit: Eq = usize>(
- ipsum: Ipsum,
- dolor: Dolor,
- sit: Sit,
- amet: Amet,
- adipiscing: Adipiscing,
- consectetur: Consectetur,
- elit: Elit)
- -> T {
- // body
+
+fn bar() {
+ println!("b");
+
+
+ println!("c");
}
```
-#### Struct
+#### `1` (default):
+```rust
+fn foo() {
+ println!("a");
+}
-#### `"Block"` (default):
+fn bar() {
+ println!("b");
-```rust
-fn main() {
- let lorem = Lorem {
- ipsum: dolor,
- sit: amet,
- };
+ println!("c");
}
```
-#### `"Visual"`:
-
+#### `2`:
```rust
-fn main() {
- let lorem = Lorem { ipsum: dolor,
- sit: amet, };
+fn foo() {
+ println!("a");
}
-```
-See also: [`struct_lit_single_line`](#struct_lit_single_line), [`indent_style`](#indent_style).
-### Where predicates
+fn bar() {
+ println!("b");
-#### `"Block"` (default):
-```rust
-fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
-where
- Ipsum: Eq,
- Dolor: Eq,
- Sit: Eq,
- Amet: Eq,
-{
- // body
+ println!("c");
}
```
-#### `"Visual"`:
+See also: [`blank_lines_lower_bound`](#blank_lines_lower_bound)
-```rust
-fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
- where Ipsum: Eq,
- Dolor: Eq,
- Sit: Eq,
- Amet: Eq
-{
- // body
-}
-```
+## `brace_style`
-## `use_small_heuristics`
+Brace style for items
-Whether to use different formatting for items and expressions if they satisfy a heuristic notion of 'small'.
+- **Default value**: `"SameLineWhere"`
+- **Possible values**: `"AlwaysNextLine"`, `"PreferSameLine"`, `"SameLineWhere"`
+- **Stable**: No (tracking issue: #3376)
-- **Default value**: `Default`
-- **Possible values**: `Default`, `Off`, `Max`
-- **Stable**: Yes
+### Functions
-#### `Default` (default):
+#### `"SameLineWhere"` (default):
```rust
-enum Lorem {
- Ipsum,
- Dolor(bool),
- Sit { amet: Consectetur, adipiscing: Elit },
+fn lorem() {
+ // body
}
-fn main() {
- lorem(
- "lorem",
- "ipsum",
- "dolor",
- "sit",
- "amet",
- "consectetur",
- "adipiscing",
- );
-
- let lorem = Lorem {
- ipsum: dolor,
- sit: amet,
- };
- let lorem = Lorem { ipsum: dolor };
+fn lorem(ipsum: usize) {
+ // body
+}
- let lorem = if ipsum { dolor } else { sit };
+fn lorem<T>(ipsum: T)
+where
+ T: Add + Sub + Mul + Div,
+{
+ // body
}
```
-#### `Off`:
+#### `"AlwaysNextLine"`:
```rust
-enum Lorem {
- Ipsum,
- Dolor(bool),
- Sit {
- amet: Consectetur,
- adipiscing: Elit,
- },
+fn lorem()
+{
+ // body
}
-fn main() {
- lorem("lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing");
-
- let lorem = Lorem {
- ipsum: dolor,
- sit: amet,
- };
+fn lorem(ipsum: usize)
+{
+ // body
+}
- let lorem = if ipsum {
- dolor
- } else {
- sit
- };
+fn lorem<T>(ipsum: T)
+where
+ T: Add + Sub + Mul + Div,
+{
+ // body
}
```
-#### `Max`:
+#### `"PreferSameLine"`:
```rust
-enum Lorem {
- Ipsum,
- Dolor(bool),
- Sit { amet: Consectetur, adipiscing: Elit },
+fn lorem() {
+ // body
}
-fn main() {
- lorem("lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing");
-
- let lorem = Lorem { ipsum: dolor, sit: amet };
+fn lorem(ipsum: usize) {
+ // body
+}
- let lorem = if ipsum { dolor } else { sit };
+fn lorem<T>(ipsum: T)
+where
+ T: Add + Sub + Mul + Div, {
+ // body
}
```
-## `binop_separator`
+### Structs and enums
-Where to put a binary operator when a binary expression goes multiline.
+#### `"SameLineWhere"` (default):
-- **Default value**: `"Front"`
-- **Possible values**: `"Front"`, `"Back"`
-- **Stable**: No
+```rust
+struct Lorem {
+ ipsum: bool,
+}
-#### `"Front"` (default):
+struct Dolor<T>
+where
+ T: Eq,
+{
+ sit: T,
+}
+```
-```rust
-fn main() {
- let or = foofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoo
- || barbarbarbarbarbarbarbarbarbarbarbarbarbarbarbar;
+#### `"AlwaysNextLine"`:
- let sum = 123456789012345678901234567890
- + 123456789012345678901234567890
- + 123456789012345678901234567890;
+```rust
+struct Lorem
+{
+ ipsum: bool,
+}
- let range = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
- ..bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;
+struct Dolor<T>
+where
+ T: Eq,
+{
+ sit: T,
}
```
-#### `"Back"`:
+#### `"PreferSameLine"`:
```rust
-fn main() {
- let or = foofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoo ||
- barbarbarbarbarbarbarbarbarbarbarbarbarbarbarbar;
-
- let sum = 123456789012345678901234567890 +
- 123456789012345678901234567890 +
- 123456789012345678901234567890;
+struct Lorem {
+ ipsum: bool,
+}
- let range = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa..
- bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;
+struct Dolor<T>
+where
+ T: Eq, {
+ sit: T,
}
```
+
+## `color`
+
+Whether to use colored output or not.
+
+- **Default value**: `"Auto"`
+- **Possible values**: "Auto", "Always", "Never"
+- **Stable**: No (tracking issue: #3385)
+
## `combine_control_expr`
Combine control expressions with function calls.
- **Default value**: `true`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3369)
#### `true` (default):
- **Default value**: `80`
- **Possible values**: any positive integer
-- **Stable**: No
+- **Stable**: No (tracking issue: #3349)
**Note:** A value of `0` results in [`wrap_comments`](#wrap_comments) being applied regardless of a line's width.
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3384)
#### `false` (default):
- **Default value**: `"AlwaysSameLine"`
- **Possible values**: `"AlwaysNextLine"`, `"AlwaysSameLine"`, `"ClosingNextLine"`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3377)
#### `"AlwaysSameLine"` (default):
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3388)
+
+## `edition`
+
+Specifies which edition is used by the parser.
+
+- **Default value**: `2015`
+- **Possible values**: `2015`, `2018`
+- **Stable**: Yes
+
+Rustfmt is able to pick up the edition used by reading the `Cargo.toml` file if executed
+through the Cargo's formatting tool `cargo fmt`. Otherwise, the edition needs to be specified
+in your config file:
+
+```toml
+edition = "2018"
+```
+
+## `empty_item_single_line`
+
+Put empty-body functions and impls on a single line
+
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3356)
+
+#### `true` (default):
+
+```rust
+fn lorem() {}
+
+impl Lorem {}
+```
+
+#### `false`:
+
+```rust
+fn lorem() {
+}
+
+impl Lorem {
+}
+```
+
+See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
+
+
+## `enum_discrim_align_threshold`
+
+The maximum length of enum variant having discriminant, that gets vertically aligned with others.
+Variants without discriminants would be ignored for the purpose of alignment.
+
+Note that this is not how much whitespace is inserted, but instead the longest variant name that
+doesn't get ignored when aligning.
+
+- **Default value** : 0
+- **Possible values**: any positive integer
+- **Stable**: No (tracking issue: #3372)
+
+#### `0` (default):
+
+```rust
+enum Bar {
+ A = 0,
+ Bb = 1,
+ RandomLongVariantGoesHere = 10,
+ Ccc = 71,
+}
+
+enum Bar {
+ VeryLongVariantNameHereA = 0,
+ VeryLongVariantNameHereBb = 1,
+ VeryLongVariantNameHereCcc = 2,
+}
+```
+
+#### `20`:
+
+```rust
+enum Foo {
+ A = 0,
+ Bb = 1,
+ RandomLongVariantGoesHere = 10,
+ Ccc = 2,
+}
+
+enum Bar {
+ VeryLongVariantNameHereA = 0,
+ VeryLongVariantNameHereBb = 1,
+ VeryLongVariantNameHereCcc = 2,
+}
+```
+
## `error_on_line_overflow`
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3391)
See also [`max_width`](#max_width).
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3392)
-## `fn_args_density`
+## `fn_args_layout`
-Argument density in functions
+Control the layout of arguments in a function
- **Default value**: `"Tall"`
- **Possible values**: `"Compressed"`, `"Tall"`, `"Vertical"`
-- **Stable**: No
+- **Stable**: Yes
#### `"Tall"` (default):
```
-## `brace_style`
-
-Brace style for items
+## `fn_single_line`
-- **Default value**: `"SameLineWhere"`
-- **Possible values**: `"AlwaysNextLine"`, `"PreferSameLine"`, `"SameLineWhere"`
-- **Stable**: No
+Put single-expression functions on a single line
-### Functions
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3358)
-#### `"SameLineWhere"` (default):
+#### `false` (default):
```rust
-fn lorem() {
- // body
-}
-
-fn lorem(ipsum: usize) {
- // body
+fn lorem() -> usize {
+ 42
}
-fn lorem<T>(ipsum: T)
-where
- T: Add + Sub + Mul + Div,
-{
- // body
+fn lorem() -> usize {
+ let ipsum = 42;
+ ipsum
}
```
-#### `"AlwaysNextLine"`:
+#### `true`:
```rust
-fn lorem()
-{
- // body
+fn lorem() -> usize { 42 }
+
+fn lorem() -> usize {
+ let ipsum = 42;
+ ipsum
}
+```
-fn lorem(ipsum: usize)
-{
- // body
+See also [`control_brace_style`](#control_brace_style).
+
+
+## `force_explicit_abi`
+
+Always print the abi for extern items
+
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: Yes
+
+**Note:** Non-"C" ABIs are always printed. If `false` then "C" is removed.
+
+#### `true` (default):
+
+```rust
+extern "C" {
+ pub static lorem: c_int;
}
+```
-fn lorem<T>(ipsum: T)
-where
- T: Add + Sub + Mul + Div,
-{
- // body
+#### `false`:
+
+```rust
+extern {
+ pub static lorem: c_int;
}
```
-#### `"PreferSameLine"`:
+## `force_multiline_blocks`
+
+Force multiline closure and match arm bodies to be wrapped in a block
+
+- **Default value**: `false`
+- **Possible values**: `false`, `true`
+- **Stable**: No (tracking issue: #3374)
+
+#### `false` (default):
```rust
-fn lorem() {
- // body
+fn main() {
+ result.and_then(|maybe_value| match maybe_value {
+ None => foo(),
+ Some(value) => bar(),
+ });
+
+ match lorem {
+ None => |ipsum| {
+ println!("Hello World");
+ },
+ Some(dolor) => foo(),
+ }
}
+```
-fn lorem(ipsum: usize) {
- // body
+#### `true`:
+
+```rust
+fn main() {
+ result.and_then(|maybe_value| {
+ match maybe_value {
+ None => foo(),
+ Some(value) => bar(),
+ }
+ });
+
+ match lorem {
+ None => {
+ |ipsum| {
+ println!("Hello World");
+ }
+ }
+ Some(dolor) => foo(),
+ }
}
+```
-fn lorem<T>(ipsum: T)
-where
- T: Add + Sub + Mul + Div, {
- // body
+
+## `format_code_in_doc_comments`
+
+Format code snippet included in doc comments.
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3348)
+
+#### `false` (default):
+
+```rust
+/// Adds one to the number given.
+///
+/// # Examples
+///
+/// ```rust
+/// let five=5;
+///
+/// assert_eq!(
+/// 6,
+/// add_one(5)
+/// );
+/// # fn add_one(x: i32) -> i32 {
+/// # x + 1
+/// # }
+/// ```
+fn add_one(x: i32) -> i32 {
+ x + 1
}
```
-### Structs and enums
+#### `true`
-#### `"SameLineWhere"` (default):
+```rust
+/// Adds one to the number given.
+///
+/// # Examples
+///
+/// ```rust
+/// let five = 5;
+///
+/// assert_eq!(6, add_one(5));
+/// # fn add_one(x: i32) -> i32 {
+/// # x + 1
+/// # }
+/// ```
+fn add_one(x: i32) -> i32 {
+ x + 1
+}
+```
+
+## `format_macro_matchers`
+
+Format the metavariable matching patterns in macros.
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3354)
+
+#### `false` (default):
```rust
-struct Lorem {
- ipsum: bool,
+macro_rules! foo {
+ ($a: ident : $b: ty) => {
+ $a(42): $b;
+ };
+ ($a: ident $b: ident $c: ident) => {
+ $a = $b + $c;
+ };
}
+```
-struct Dolor<T>
-where
- T: Eq,
-{
- sit: T,
+#### `true`:
+
+```rust
+macro_rules! foo {
+ ($a:ident : $b:ty) => {
+ $a(42): $b;
+ };
+ ($a:ident $b:ident $c:ident) => {
+ $a = $b + $c;
+ };
}
```
-#### `"AlwaysNextLine"`:
+See also [`format_macro_bodies`](#format_macro_bodies).
+
+
+## `format_macro_bodies`
+
+Format the bodies of macros.
+
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3355)
+
+#### `true` (default):
```rust
-struct Lorem
-{
- ipsum: bool,
+macro_rules! foo {
+ ($a: ident : $b: ty) => {
+ $a(42): $b;
+ };
+ ($a: ident $b: ident $c: ident) => {
+ $a = $b + $c;
+ };
}
+```
-struct Dolor<T>
-where
- T: Eq,
-{
- sit: T,
+#### `false`:
+
+```rust
+macro_rules! foo {
+ ($a: ident : $b: ty) => { $a(42): $b; };
+ ($a: ident $b: ident $c: ident) => { $a=$b+$c; };
}
```
-#### `"PreferSameLine"`:
+See also [`format_macro_matchers`](#format_macro_matchers).
+
+
+## `format_strings`
+
+Format string literals where necessary
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3353)
+
+#### `false` (default):
```rust
-struct Lorem {
- ipsum: bool,
+fn main() {
+ let lorem = "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet consectetur adipiscing";
}
+```
-struct Dolor<T>
-where
- T: Eq, {
- sit: T,
+#### `true`:
+
+```rust
+fn main() {
+ let lorem = "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet \
+ consectetur adipiscing";
}
```
+See also [`max_width`](#max_width).
+
+## `hard_tabs`
+
+Use tab characters for indentation, spaces for alignment
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: Yes
+
+#### `false` (default):
+
+```rust
+fn lorem() -> usize {
+ 42 // spaces before 42
+}
+```
+
+#### `true`:
+
+```rust
+fn lorem() -> usize {
+ 42 // tabs before 42
+}
+```
+
+See also: [`tab_spaces`](#tab_spaces).
+
+
+## `hide_parse_errors`
+
+Do not show parse errors if the parser failed to parse files.
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3390)
+
+## `ignore`
+
+Skip formatting files and directories that match the specified pattern.
+The pattern format is the same as [.gitignore](https://git-scm.com/docs/gitignore#_pattern_format). Be sure to use Unix/forwardslash `/` style paths. This path style will work on all platforms. Windows style paths with backslashes `\` are not supported.
+
+- **Default value**: format every file
+- **Possible values**: See an example below
+- **Stable**: No (tracking issue: #3395)
+
+### Example
+
+If you want to ignore specific files, put the following to your config file:
+
+```toml
+ignore = [
+ "src/types.rs",
+ "src/foo/bar.rs",
+]
+```
+
+If you want to ignore every file under `examples/`, put the following to your config file:
+
+```toml
+ignore = [
+ "examples",
+]
+```
+
+If you want to ignore every file under the directory where you put your rustfmt.toml:
+
+```toml
+ignore = ["/"]
+```
+
+## `imports_indent`
+
+Indent style of imports
+
+- **Default Value**: `"Block"`
+- **Possible values**: `"Block"`, `"Visual"`
+- **Stable**: No (tracking issue: #3360)
+
+#### `"Block"` (default):
+
+```rust
+use foo::{
+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy,
+ zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
+};
+```
+
+#### `"Visual"`:
+
+```rust
+use foo::{xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy,
+ zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz};
+```
+
+See also: [`imports_layout`](#imports_layout).
+
+## `imports_layout`
+
+Item layout inside a imports block
+
+- **Default value**: "Mixed"
+- **Possible values**: "Horizontal", "HorizontalVertical", "Mixed", "Vertical"
+- **Stable**: No (tracking issue: #3361)
+
+#### `"Mixed"` (default):
+
+```rust
+use foo::{xxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyy, zzzzzzzzzzzzzzzzzz};
+
+use foo::{
+ aaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbb, cccccccccccccccccc, dddddddddddddddddd,
+ eeeeeeeeeeeeeeeeee, ffffffffffffffffff,
+};
+```
+
+#### `"Horizontal"`:
-## `empty_item_single_line`
+**Note**: This option forces all imports onto one line and may exceed `max_width`.
-Put empty-body functions and impls on a single line
+```rust
+use foo::{xxx, yyy, zzz};
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+use foo::{aaa, bbb, ccc, ddd, eee, fff};
+```
-#### `true` (default):
+#### `"HorizontalVertical"`:
```rust
-fn lorem() {}
+use foo::{xxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyy, zzzzzzzzzzzzzzzzzz};
-impl Lorem {}
+use foo::{
+ aaaaaaaaaaaaaaaaaa,
+ bbbbbbbbbbbbbbbbbb,
+ cccccccccccccccccc,
+ dddddddddddddddddd,
+ eeeeeeeeeeeeeeeeee,
+ ffffffffffffffffff,
+};
```
-#### `false`:
+#### `"Vertical"`:
```rust
-fn lorem() {
-}
+use foo::{
+ xxx,
+ yyy,
+ zzz,
+};
-impl Lorem {
-}
+use foo::{
+ aaa,
+ bbb,
+ ccc,
+ ddd,
+ eee,
+ fff,
+};
```
-See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
-
+## `indent_style`
-## `fn_single_line`
+Indent on expressions or items.
-Put single-expression functions on a single line
+- **Default value**: `"Block"`
+- **Possible values**: `"Block"`, `"Visual"`
+- **Stable**: No (tracking issue: #3346)
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+### Array
-#### `false` (default):
+#### `"Block"` (default):
```rust
-fn lorem() -> usize {
- 42
+fn main() {
+ let lorem = vec![
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit",
+ ];
}
+```
-fn lorem() -> usize {
- let ipsum = 42;
- ipsum
+#### `"Visual"`:
+
+```rust
+fn main() {
+ let lorem = vec!["ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit"];
}
```
-#### `true`:
+### Control flow
-```rust
-fn lorem() -> usize { 42 }
+#### `"Block"` (default):
-fn lorem() -> usize {
- let ipsum = 42;
- ipsum
+```rust
+fn main() {
+ if lorem_ipsum
+ && dolor_sit
+ && amet_consectetur
+ && lorem_sit
+ && dolor_consectetur
+ && amet_ipsum
+ && lorem_consectetur
+ {
+ // ...
+ }
}
```
-See also [`control_brace_style`](#control_brace_style).
-
+#### `"Visual"`:
-## `where_single_line`
+```rust
+fn main() {
+ if lorem_ipsum
+ && dolor_sit
+ && amet_consectetur
+ && lorem_sit
+ && dolor_consectetur
+ && amet_ipsum
+ && lorem_consectetur
+ {
+ // ...
+ }
+}
+```
-Forces the `where` clause to be laid out on a single line.
+See also: [`control_brace_style`](#control_brace_style).
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+### Function arguments
-#### `false` (default):
+#### `"Block"` (default):
```rust
-impl<T> Lorem for T
-where
- Option<T>: Ipsum,
-{
+fn lorem() {}
+
+fn lorem(ipsum: usize) {}
+
+fn lorem(
+ ipsum: usize,
+ dolor: usize,
+ sit: usize,
+ amet: usize,
+ consectetur: usize,
+ adipiscing: usize,
+ elit: usize,
+) {
// body
}
```
-#### `true`:
+#### `"Visual"`:
```rust
-impl<T> Lorem for T
-where Option<T>: Ipsum
-{
+fn lorem() {}
+
+fn lorem(ipsum: usize) {}
+
+fn lorem(ipsum: usize,
+ dolor: usize,
+ sit: usize,
+ amet: usize,
+ consectetur: usize,
+ adipiscing: usize,
+ elit: usize) {
// body
}
```
-See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
+### Function calls
+#### `"Block"` (default):
-## `force_explicit_abi`
+```rust
+fn main() {
+ lorem(
+ "lorem",
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit",
+ );
+}
+```
-Always print the abi for extern items
+#### `"Visual"`:
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
+```rust
+fn main() {
+ lorem("lorem",
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit");
+}
+```
-**Note:** Non-"C" ABIs are always printed. If `false` then "C" is removed.
+### Generics
-#### `true` (default):
+#### `"Block"` (default):
```rust
-extern "C" {
- pub static lorem: c_int;
+fn lorem<
+ Ipsum: Eq = usize,
+ Dolor: Eq = usize,
+ Sit: Eq = usize,
+ Amet: Eq = usize,
+ Adipiscing: Eq = usize,
+ Consectetur: Eq = usize,
+ Elit: Eq = usize,
+>(
+ ipsum: Ipsum,
+ dolor: Dolor,
+ sit: Sit,
+ amet: Amet,
+ adipiscing: Adipiscing,
+ consectetur: Consectetur,
+ elit: Elit,
+) -> T {
+ // body
}
```
-#### `false`:
+#### `"Visual"`:
```rust
-extern {
- pub static lorem: c_int;
+fn lorem<Ipsum: Eq = usize,
+ Dolor: Eq = usize,
+ Sit: Eq = usize,
+ Amet: Eq = usize,
+ Adipiscing: Eq = usize,
+ Consectetur: Eq = usize,
+ Elit: Eq = usize>(
+ ipsum: Ipsum,
+ dolor: Dolor,
+ sit: Sit,
+ amet: Amet,
+ adipiscing: Adipiscing,
+ consectetur: Consectetur,
+ elit: Elit)
+ -> T {
+ // body
}
```
-## `format_strings`
-
-Format string literals where necessary
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+#### Struct
-#### `false` (default):
+#### `"Block"` (default):
```rust
fn main() {
- let lorem =
- "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet consectetur adipiscing";
+ let lorem = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
}
```
-#### `true`:
+#### `"Visual"`:
```rust
fn main() {
- let lorem = "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet \
- consectetur adipiscing";
+ let lorem = Lorem { ipsum: dolor,
+ sit: amet };
}
```
-See also [`max_width`](#max_width).
-
-## `hard_tabs`
-
-Use tab characters for indentation, spaces for alignment
+See also: [`struct_lit_single_line`](#struct_lit_single_line), [`indent_style`](#indent_style).
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
+### Where predicates
-#### `false` (default):
+#### `"Block"` (default):
```rust
-fn lorem() -> usize {
- 42 // spaces before 42
+fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
+where
+ Ipsum: Eq,
+ Dolor: Eq,
+ Sit: Eq,
+ Amet: Eq,
+{
+ // body
}
```
-#### `true`:
+#### `"Visual"`:
```rust
-fn lorem() -> usize {
- 42 // tabs before 42
+fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
+ where Ipsum: Eq,
+ Dolor: Eq,
+ Sit: Eq,
+ Amet: Eq
+{
+ // body
}
```
-See also: [`tab_spaces`](#tab_spaces).
-
+## `inline_attribute_width`
-## `imports_indent`
-
-Indent style of imports
+Write an item and its attribute on the same line if their combined width is below a threshold
-- **Default Value**: `"Block"`
-- **Possible values**: `"Block"`, `"Visual"`
-- **Stable**: No
+- **Default value**: 0
+- **Possible values**: any positive integer
+- **Stable**: No (tracking issue: #3343)
-#### `"Block"` (default):
+### Example
+#### `0` (default):
```rust
-use foo::{
- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy,
- zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
-};
+#[cfg(feature = "alloc")]
+use core::slice;
```
-#### `"Visual"`:
-
+#### `50`:
```rust
-use foo::{xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy,
- zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz};
+#[cfg(feature = "alloc")] use core::slice;
```
-See also: [`imports_layout`](#imports_layout).
-
-## `imports_layout`
-
-Item layout inside a imports block
+## `license_template_path`
-- **Default value**: "Mixed"
-- **Possible values**: "Horizontal", "HorizontalVertical", "Mixed", "Vertical"
-- **Stable**: No
+Check whether beginnings of files match a license template.
-#### `"Mixed"` (default):
+- **Default value**: `""`
+- **Possible values**: path to a license template file
+- **Stable**: No (tracking issue: #3352)
-```rust
-use foo::{xxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyy, zzzzzzzzzzzzzzzzzz};
+A license template is a plain text file which is matched literally against the
+beginning of each source file, except for `{}`-delimited blocks, which are
+matched as regular expressions. The following license template therefore
+matches strings like `// Copyright 2017 The Rust Project Developers.`, `//
+Copyright 2018 The Rust Project Developers.`, etc.:
-use foo::{
- aaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbb, cccccccccccccccccc, dddddddddddddddddd,
- eeeeeeeeeeeeeeeeee, ffffffffffffffffff,
-};
+```
+// Copyright {\d+} The Rust Project Developers.
```
-#### `"Horizontal"`:
+`\{`, `\}` and `\\` match literal braces / backslashes.
-**Note**: This option forces all imports onto one line and may exceed `max_width`.
+## `match_arm_blocks`
-```rust
-use foo::{xxx, yyy, zzz};
+Wrap the body of arms in blocks when it does not fit on the same line with the pattern of arms
-use foo::{aaa, bbb, ccc, ddd, eee, fff};
-```
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3373)
-#### `"HorizontalVertical"`:
+#### `true` (default):
```rust
-use foo::{xxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyy, zzzzzzzzzzzzzzzzzz};
-
-use foo::{
- aaaaaaaaaaaaaaaaaa,
- bbbbbbbbbbbbbbbbbb,
- cccccccccccccccccc,
- dddddddddddddddddd,
- eeeeeeeeeeeeeeeeee,
- ffffffffffffffffff,
-};
+fn main() {
+ match lorem {
+ true => {
+ foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x)
+ }
+ false => println!("{}", sit),
+ }
+}
```
-#### `"Vertical"`:
+#### `false`:
```rust
-use foo::{
- xxx,
- yyy,
- zzz,
-};
-
-use foo::{
- aaa,
- bbb,
- ccc,
- ddd,
- eee,
- fff,
-};
+fn main() {
+ match lorem {
+ true =>
+ foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x),
+ false => println!("{}", sit),
+ }
+}
```
-## `merge_imports`
+See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
-Merge multiple imports into a single nested import.
+## `match_arm_leading_pipes`
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+Controls whether to include a leading pipe on match arms
-#### `false` (default):
+- **Default value**: `Never`
+- **Possible values**: `Always`, `Never`, `Preserve`
+- **Stable**: Yes
-```rust
-use foo::{a, c, d};
-use foo::{b, g};
-use foo::{e, f};
+#### `Never` (default):
+```rust
+// Leading pipes are removed from this:
+// fn foo() {
+// match foo {
+// | "foo" | "bar" => {}
+// | "baz"
+// | "something relatively long"
+// | "something really really really realllllllllllllly long" => println!("x"),
+// | "qux" => println!("y"),
+// _ => {}
+// }
+// }
+
+// Becomes
+fn foo() {
+ match foo {
+ "foo" | "bar" => {}
+ "baz"
+ | "something relatively long"
+ | "something really really really realllllllllllllly long" => println!("x"),
+ "qux" => println!("y"),
+ _ => {}
+ }
+}
```
-#### `true`:
-
+#### `Always`:
```rust
-use foo::{a, b, c, d, e, f, g};
+// Leading pipes are emitted on all arms of this:
+// fn foo() {
+// match foo {
+// "foo" | "bar" => {}
+// "baz"
+// | "something relatively long"
+// | "something really really really realllllllllllllly long" => println!("x"),
+// "qux" => println!("y"),
+// _ => {}
+// }
+// }
+
+// Becomes:
+fn foo() {
+ match foo {
+ | "foo" | "bar" => {}
+ | "baz"
+ | "something relatively long"
+ | "something really really really realllllllllllllly long" => println!("x"),
+ | "qux" => println!("y"),
+ | _ => {}
+ }
+}
```
+#### `Preserve`:
+```rust
+fn foo() {
+ match foo {
+ | "foo" | "bar" => {}
+ | "baz"
+ | "something relatively long"
+ | "something really really really realllllllllllllly long" => println!("x"),
+ | "qux" => println!("y"),
+ _ => {}
+ }
+
+ match baz {
+ "qux" => {}
+ "foo" | "bar" => {}
+ _ => {}
+ }
+}
+```
## `match_block_trailing_comma`
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3380)
#### `false` (default):
pub enum Foo {}
```
-## `force_multiline_blocks`
+## `merge_imports`
-Force multiline closure and match arm bodies to be wrapped in a block
+Merge multiple imports into a single nested import.
- **Default value**: `false`
-- **Possible values**: `false`, `true`
-- **Stable**: No
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3362)
#### `false` (default):
```rust
-fn main() {
- result.and_then(|maybe_value| match maybe_value {
- None => foo(),
- Some(value) => bar(),
- });
-
- match lorem {
- None => if ipsum {
- println!("Hello World");
- },
- Some(dolor) => foo(),
- }
-}
+use foo::{a, c, d};
+use foo::{b, g};
+use foo::{e, f};
```
#### `true`:
```rust
-fn main() {
- result.and_then(|maybe_value| {
- match maybe_value {
- None => foo(),
- Some(value) => bar(),
- }
- });
-
- match lorem {
- None => {
- if ipsum {
- println!("Hello World");
- }
- }
- Some(dolor) => foo(),
- }
-}
+use foo::{a, b, c, d, e, f, g};
```
Unix or Windows line endings
-- **Default value**: `"Native"`
-- **Possible values**: `"Native"`, `"Unix"`, `"Windows"`
+- **Default value**: `"Auto"`
+- **Possible values**: `"Auto"`, `"Native"`, `"Unix"`, `"Windows"`
- **Stable**: Yes
-## `normalize_comments`
+#### `Auto` (default):
+
+The newline style is detected automatically on a per-file basis. Files
+with mixed line endings will be converted to the first detected line
+ending style.
+
+#### `Native`
+
+Line endings will be converted to `\r\n` on Windows and `\n` on all
+other platforms.
+
+#### `Unix`
+
+Line endings will be converted to `\n`.
+
+#### `Windows`
+
+Line endings will be converted to `\r\n`.
+
+## `normalize_comments`
+
+Convert /* */ comments to // comments where possible
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3350)
+
+#### `false` (default):
+
+```rust
+// Lorem ipsum:
+fn dolor() -> usize {}
+
+/* sit amet: */
+fn adipiscing() -> usize {}
+```
+
+#### `true`:
+
+```rust
+// Lorem ipsum:
+fn dolor() -> usize {}
+
+// sit amet:
+fn adipiscing() -> usize {}
+```
+
+## `normalize_doc_attributes`
+
+Convert `#![doc]` and `#[doc]` attributes to `//!` and `///` doc comments.
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3351)
+
+#### `false` (default):
+
+```rust
+#![doc = "Example documentation"]
+
+#[doc = "Example item documentation"]
+pub enum Foo {}
+```
+
+#### `true`:
+
+```rust
+//! Example documentation
+
+/// Example item documentation
+pub enum Foo {}
+```
+
+## `overflow_delimited_expr`
-Convert /* */ comments to // comments where possible
+When structs, slices, arrays, and block/array-like macros are used as the last
+argument in an expression list, allow them to overflow (like blocks/closures)
+instead of being indented on a new line.
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3370)
#### `false` (default):
```rust
-// Lorem ipsum:
-fn dolor() -> usize {}
+fn example() {
+ foo(ctx, |param| {
+ action();
+ foo(param)
+ });
-/* sit amet: */
-fn adipiscing() -> usize {}
+ foo(
+ ctx,
+ Bar {
+ x: value,
+ y: value2,
+ },
+ );
+
+ foo(
+ ctx,
+ &[
+ MAROON_TOMATOES,
+ PURPLE_POTATOES,
+ ORGANE_ORANGES,
+ GREEN_PEARS,
+ RED_APPLES,
+ ],
+ );
+
+ foo(
+ ctx,
+ vec![
+ MAROON_TOMATOES,
+ PURPLE_POTATOES,
+ ORGANE_ORANGES,
+ GREEN_PEARS,
+ RED_APPLES,
+ ],
+ );
+}
```
#### `true`:
```rust
-// Lorem ipsum:
-fn dolor() -> usize {}
+fn example() {
+ foo(ctx, |param| {
+ action();
+ foo(param)
+ });
-// sit amet:
-fn adipiscing() -> usize {}
+ foo(ctx, Bar {
+ x: value,
+ y: value2,
+ });
+
+ foo(ctx, &[
+ MAROON_TOMATOES,
+ PURPLE_POTATOES,
+ ORGANE_ORANGES,
+ GREEN_PEARS,
+ RED_APPLES,
+ ]);
+
+ foo(ctx, vec![
+ MAROON_TOMATOES,
+ PURPLE_POTATOES,
+ ORGANE_ORANGES,
+ GREEN_PEARS,
+ RED_APPLES,
+ ]);
+}
```
## `remove_nested_parens`
```
+## `reorder_impl_items`
+
+Reorder impl items. `type` and `const` are put first, then macros and methods.
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3363)
+
+#### `false` (default)
+
+```rust
+struct Dummy;
+
+impl Iterator for Dummy {
+ fn next(&mut self) -> Option<Self::Item> {
+ None
+ }
+
+ type Item = i32;
+}
+```
+
+#### `true`
+
+```rust
+struct Dummy;
+
+impl Iterator for Dummy {
+ type Item = i32;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ None
+ }
+}
+```
+
## `reorder_imports`
Reorder import and extern crate statements alphabetically in groups (a group is
mod sit;
```
-**Note** `mod` with `#[macro_export]` will not be reordered since that could change the semantic
+**Note** `mod` with `#[macro_export]` will not be reordered since that could change the semantics
of the original source code.
-## `reorder_impl_items`
-
-Reorder impl items. `type` and `const` are put first, then macros and methods.
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
-
-#### `false` (default)
-
-```rust
-struct Dummy;
-
-impl Iterator for Dummy {
- fn next(&mut self) -> Option<Self::Item> {
- None
- }
+## `report_fixme`
- type Item = i32;
-}
-```
+Report `FIXME` items in comments.
-#### `true`
+- **Default value**: `"Never"`
+- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
+- **Stable**: No (tracking issue: #3394)
-```rust
-struct Dummy;
+Warns about any comments containing `FIXME` in them when set to `"Always"`. If
+it contains a `#X` (with `X` being a number) in parentheses following the
+`FIXME`, `"Unnumbered"` will ignore it.
-impl Iterator for Dummy {
- type Item = i32;
+See also [`report_todo`](#report_todo).
- fn next(&mut self) -> Option<Self::Item> {
- None
- }
-}
-```
## `report_todo`
- **Default value**: `"Never"`
- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3393)
Warns about any comments containing `TODO` in them when set to `"Always"`. If
it contains a `#X` (with `X` being a number) in parentheses following the
See also [`report_fixme`](#report_fixme).
-## `report_fixme`
-
-Report `FIXME` items in comments.
-
-- **Default value**: `"Never"`
-- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
-- **Stable**: No
-
-Warns about any comments containing `FIXME` in them when set to `"Always"`. If
-it contains a `#X` (with `X` being a number) in parentheses following the
-`FIXME`, `"Unnumbered"` will ignore it.
+## `required_version`
-See also [`report_todo`](#report_todo).
+Require a specific version of rustfmt. If you want to make sure that the
+specific version of rustfmt is used in your CI, use this option.
+- **Default value**: `CARGO_PKG_VERSION`
+- **Possible values**: any published version (e.g. `"0.3.8"`)
+- **Stable**: No (tracking issue: #3386)
## `skip_children`
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3389)
## `space_after_colon`
- **Default value**: `true`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3366)
#### `true` (default):
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3365)
#### `false` (default):
See also: [`space_after_colon`](#space_after_colon).
-## `struct_field_align_threshold`
-
-The maximum diff of width between struct fields to be aligned with each other.
-
-- **Default value** : 0
-- **Possible values**: any positive integer
-- **Stable**: No
-
-#### `0` (default):
-
-```rust
-struct Foo {
- x: u32,
- yy: u32,
- zzz: u32,
-}
-```
-
-#### `20`:
-
-```rust
-struct Foo {
- x: u32,
- yy: u32,
- zzz: u32,
-}
-```
-
## `spaces_around_ranges`
Put spaces around the .., ..=, and ... range operators
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3367)
#### `false` (default):
}
```
+## `struct_field_align_threshold`
+
+The maximum diff of width between struct fields to be aligned with each other.
+
+- **Default value** : 0
+- **Possible values**: any non-negative integer
+- **Stable**: No (tracking issue: #3371)
+
+#### `0` (default):
+
+```rust
+struct Foo {
+ x: u32,
+ yy: u32,
+ zzz: u32,
+}
+```
+
+#### `20`:
+
+```rust
+struct Foo {
+ x: u32,
+ yy: u32,
+ zzz: u32,
+}
+```
+
## `struct_lit_single_line`
Put small struct literals on a single line
- **Default value**: `true`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3357)
#### `true` (default):
- **Default value**: `"Vertical"`
- **Possible values**: `"Always"`, `"Never"`, `"Vertical"`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3379)
#### `"Vertical"` (default):
- **Default value**: `true`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3378)
#### `true` (default):
```rust
- **Default value**: `"Wide"`
- **Possible values**: `"Compressed"`, `"Wide"`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3364)
#### `"Wide"` (default):
}
```
-## `use_field_init_shorthand`
-
-Use field initialize shorthand if possible.
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
-
-#### `false` (default):
-
-```rust
-struct Foo {
- x: u32,
- y: u32,
- z: u32,
-}
-
-fn main() {
- let x = 1;
- let y = 2;
- let z = 3;
- let a = Foo { x: x, y: y, z: z };
-}
-```
-
-#### `true`:
-
-```rust
-struct Foo {
- x: u32,
- y: u32,
- z: u32,
-}
-
-fn main() {
- let x = 1;
- let y = 2;
- let z = 3;
- let a = Foo { x, y, z };
-}
-```
-
-## `use_try_shorthand`
+## `unstable_features`
-Replace uses of the try! macro by the ? shorthand
+Enable unstable features on the unstable channel.
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: Yes
-
-#### `false` (default):
-
-```rust
-fn main() {
- let lorem = try!(ipsum.map(|dolor| dolor.sit()));
-}
-```
-
-#### `true`:
-
-```rust
-fn main() {
- let lorem = ipsum.map(|dolor| dolor.sit())?;
-}
-```
+- **Stable**: No (tracking issue: #3387)
+## `use_field_init_shorthand`
-## `wrap_comments`
-
-Break comments to fit on the line
+Use field initialize shorthand if possible.
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
-
-#### `false` (default):
-
-```rust
-// Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
-```
-
-#### `true`:
-
-```rust
-// Lorem ipsum dolor sit amet, consectetur adipiscing elit,
-// sed do eiusmod tempor incididunt ut labore et dolore
-// magna aliqua. Ut enim ad minim veniam, quis nostrud
-// exercitation ullamco laboris nisi ut aliquip ex ea
-// commodo consequat.
-```
-
-## `match_arm_blocks`
-
-Wrap the body of arms in blocks when it does not fit on the same line with the pattern of arms
-
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: Yes
-#### `true` (default):
+#### `false` (default):
```rust
+struct Foo {
+ x: u32,
+ y: u32,
+ z: u32,
+}
+
fn main() {
- match lorem {
- true => {
- foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x)
- }
- false => println!("{}", sit),
- }
+ let x = 1;
+ let y = 2;
+ let z = 3;
+ let a = Foo { x: x, y: y, z: z };
}
```
-#### `false`:
+#### `true`:
```rust
+struct Foo {
+ x: u32,
+ y: u32,
+ z: u32,
+}
+
fn main() {
- match lorem {
- true =>
- foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x),
- false => println!("{}", sit),
- }
+ let x = 1;
+ let y = 2;
+ let z = 3;
+ let a = Foo { x, y, z };
}
```
-See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
-
-
-## `blank_lines_upper_bound`
+## `use_small_heuristics`
-Maximum number of blank lines which can be put between items. If more than this number of consecutive empty
-lines are found, they are trimmed down to match this integer.
+Whether to use different formatting for items and expressions if they satisfy a heuristic notion of 'small'.
-- **Default value**: `1`
-- **Possible values**: *unsigned integer*
-- **Stable**: No
+- **Default value**: `"Default"`
+- **Possible values**: `"Default"`, `"Off"`, `"Max"`
+- **Stable**: Yes
-### Example
-Original Code:
+#### `Default` (default):
```rust
-#![rustfmt::skip]
-
-fn foo() {
- println!("a");
+enum Lorem {
+ Ipsum,
+ Dolor(bool),
+ Sit { amet: Consectetur, adipiscing: Elit },
}
+fn main() {
+ lorem(
+ "lorem",
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ );
+ let lorem = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
+ let lorem = Lorem { ipsum: dolor };
-fn bar() {
- println!("b");
-
-
- println!("c");
+ let lorem = if ipsum { dolor } else { sit };
}
```
-#### `1` (default):
+#### `Off`:
+
```rust
-fn foo() {
- println!("a");
+enum Lorem {
+ Ipsum,
+ Dolor(bool),
+ Sit {
+ amet: Consectetur,
+ adipiscing: Elit,
+ },
}
-fn bar() {
- println!("b");
+fn main() {
+ lorem("lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing");
- println!("c");
+ let lorem = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
+
+ let lorem = if ipsum {
+ dolor
+ } else {
+ sit
+ };
}
```
-#### `2`:
+#### `Max`:
+
```rust
-fn foo() {
- println!("a");
+enum Lorem {
+ Ipsum,
+ Dolor(bool),
+ Sit { amet: Consectetur, adipiscing: Elit },
}
+fn main() {
+ lorem("lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing");
-fn bar() {
- println!("b");
-
+ let lorem = Lorem { ipsum: dolor, sit: amet };
- println!("c");
+ let lorem = if ipsum { dolor } else { sit };
}
```
-See also: [`blank_lines_lower_bound`](#blank_lines_lower_bound)
-
-## `blank_lines_lower_bound`
+## `use_try_shorthand`
-Minimum number of blank lines which must be put between items. If two items have fewer blank lines between
-them, additional blank lines are inserted.
+Replace uses of the try! macro by the ? shorthand
-- **Default value**: `0`
-- **Possible values**: *unsigned integer*
-- **Stable**: No
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: Yes
-### Example
-Original Code (rustfmt will not change it with the default value of `0`):
+#### `false` (default):
```rust
-#![rustfmt::skip]
-
-fn foo() {
- println!("a");
-}
-fn bar() {
- println!("b");
- println!("c");
+fn main() {
+ let lorem = try!(ipsum.map(|dolor| dolor.sit()));
}
```
-#### `1`
-```rust
-fn foo() {
-
- println!("a");
-}
-
-fn bar() {
-
- println!("b");
+#### `true`:
- println!("c");
+```rust
+fn main() {
+ let lorem = ipsum.map(|dolor| dolor.sit())?;
}
```
+## `version`
-## `required_version`
-
-Require a specific version of rustfmt. If you want to make sure that the
-specific version of rustfmt is used in your CI, use this option.
-
-- **Default value**: `CARGO_PKG_VERSION`
-- **Possible values**: any published version (e.g. `"0.3.8"`)
-- **Stable**: No
-
-## `hide_parse_errors`
-
-Do not show parse errors if the parser failed to parse files.
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+Which version of the formatting rules to use. `Version::One` is backwards-compatible
+with Rustfmt 1.0. Other versions are only backwards compatible within a major
+version number.
-## `color`
+- **Default value**: `One`
+- **Possible values**: `One`, `Two`
+- **Stable**: No (tracking issue: #3383)
-Whether to use colored output or not.
+### Example
-- **Default value**: `"Auto"`
-- **Possible values**: "Auto", "Always", "Never"
-- **Stable**: No
+```toml
+version = "Two"
+```
-## `unstable_features`
+## `where_single_line`
-Enable unstable features on stable channel.
+Forces the `where` clause to be laid out on a single line.
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
-
-## `license_template_path`
+- **Stable**: No (tracking issue: #3359)
-Check whether beginnings of files match a license template.
+#### `false` (default):
-- **Default value**: `""``
-- **Possible values**: path to a license template file
-- **Stable**: No
+```rust
+impl<T> Lorem for T
+where
+ Option<T>: Ipsum,
+{
+ // body
+}
+```
-A license template is a plain text file which is matched literally against the
-beginning of each source file, except for `{}`-delimited blocks, which are
-matched as regular expressions. The following license template therefore
-matches strings like `// Copyright 2017 The Rust Project Developers.`, `//
-Copyright 2018 The Rust Project Developers.`, etc.:
+#### `true`:
-```
-// Copyright {\d+} The Rust Project Developers.
+```rust
+impl<T> Lorem for T
+where Option<T>: Ipsum
+{
+ // body
+}
```
-`\{`, `\}` and `\\` match literal braces / backslashes.
+See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
-## `ignore`
-Skip formatting the specified files and directories.
+## `wrap_comments`
-- **Default value**: format every files
-- **Possible values**: See an example below
-- **Stable**: No
+Break comments to fit on the line
-### Example
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3347)
-If you want to ignore specific files, put the following to your config file:
+#### `false` (default):
-```toml
-ignore = [
- "src/types.rs",
- "src/foo/bar.rs",
-]
+```rust
+// Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
```
-If you want to ignore every file under `examples/`, put the following to your config file:
+#### `true`:
-```toml
-ignore = [
- "examples",
-]
+```rust
+// Lorem ipsum dolor sit amet, consectetur adipiscing elit,
+// sed do eiusmod tempor incididunt ut labore et dolore
+// magna aliqua. Ut enim ad minim veniam, quis nostrud
+// exercitation ullamco laboris nisi ut aliquip ex ea
+// commodo consequat.
```
-## `edition`
-
-Specifies which edition is used by the parser.
-
-- **Default value**: `Edition2015`
-- **Possible values**: `Edition2015`, `Edition2018`
-- **Stable**: No
-
-### Example
-
-If you want to format code that requires edition 2018, add the following to your config file:
-
-```toml
-edition = "Edition2018"
-```
+# Internal Options
## `emit_mode`
## `make_backup`
Internal option, use `--backup`
+
+## `print_misformatted_file_names`
+
+Internal option, use `-l` or `--files-with-diff`
projects / rust.git / blobdiff