Below you find a detailed visual guide on all the supported configuration options of rustfmt:
-## `indent_style` (tracking issue #3346)
+## `binop_separator`
-Indent on expressions or items.
-
-- **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"`:
+
+## `blank_lines_upper_bound`
+
+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.
+
+- **Default value**: `1`
+- **Possible values**: any non-negative integer
+- **Stable**: No (tracking issue: #3381)
+
+### Example
+Original Code:
```rust
-fn main() {
- lorem("lorem",
- "ipsum",
- "dolor",
- "sit",
- "amet",
- "consectetur",
- "adipiscing",
- "elit");
+#![rustfmt::skip]
+
+fn foo() {
+ println!("a");
}
-```
-### Generics
-#### `"Block"` (default):
-```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");
}
```
-#### `"Visual"`:
-
+#### `1` (default):
```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 foo() {
+ println!("a");
}
-```
-#### Struct
+fn bar() {
+ println!("b");
-#### `"Block"` (default):
+ println!("c");
+}
+```
+#### `2`:
```rust
-fn main() {
- let lorem = Lorem {
- ipsum: dolor,
- sit: amet,
- };
+fn foo() {
+ println!("a");
}
-```
-#### `"Visual"`:
-```rust
-fn main() {
- let lorem = Lorem { ipsum: dolor,
- sit: amet };
+fn bar() {
+ println!("b");
+
+
+ println!("c");
}
```
-See also: [`struct_lit_single_line`](#struct_lit_single_line), [`indent_style`](#indent_style).
+See also: [`blank_lines_lower_bound`](#blank_lines_lower_bound)
-### Where predicates
+## `brace_style`
-#### `"Block"` (default):
+Brace style for items
+
+- **Default value**: `"SameLineWhere"`
+- **Possible values**: `"AlwaysNextLine"`, `"PreferSameLine"`, `"SameLineWhere"`
+- **Stable**: No (tracking issue: #3376)
+
+### Functions
+
+#### `"SameLineWhere"` (default):
```rust
-fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
+fn lorem() {
+ // body
+}
+
+fn lorem(ipsum: usize) {
+ // body
+}
+
+fn lorem<T>(ipsum: T)
where
- Ipsum: Eq,
- Dolor: Eq,
- Sit: Eq,
- Amet: Eq,
+ T: Add + Sub + Mul + Div,
{
// body
}
```
-#### `"Visual"`:
+#### `"AlwaysNextLine"`:
```rust
-fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
- where Ipsum: Eq,
- Dolor: Eq,
- Sit: Eq,
- Amet: Eq
+fn lorem()
{
// body
}
-```
-
-## `use_small_heuristics`
-Whether to use different formatting for items and expressions if they satisfy a heuristic notion of 'small'.
+fn lorem(ipsum: usize)
+{
+ // body
+}
-- **Default value**: `"Default"`
-- **Possible values**: `"Default"`, `"Off"`, `"Max"`
-- **Stable**: Yes
+fn lorem<T>(ipsum: T)
+where
+ T: Add + Sub + Mul + Div,
+{
+ // body
+}
+```
-#### `Default` (default):
+#### `"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,
- };
- 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`:
+### Structs and enums
+
+#### `"SameLineWhere"` (default):
```rust
-enum Lorem {
- Ipsum,
- Dolor(bool),
- Sit {
- amet: Consectetur,
- adipiscing: Elit,
- },
+struct Lorem {
+ ipsum: bool,
}
-fn main() {
- lorem("lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing");
-
- let lorem = Lorem {
- ipsum: dolor,
- sit: amet,
- };
-
- let lorem = if ipsum {
- dolor
- } else {
- sit
- };
+struct Dolor<T>
+where
+ T: Eq,
+{
+ sit: T,
}
```
-#### `Max`:
+#### `"AlwaysNextLine"`:
```rust
-enum Lorem {
- Ipsum,
- Dolor(bool),
- Sit { amet: Consectetur, adipiscing: Elit },
+struct Lorem
+{
+ ipsum: bool,
}
-fn main() {
- lorem("lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing");
-
- let lorem = Lorem { ipsum: dolor, sit: amet };
-
- let lorem = if ipsum { dolor } else { sit };
+struct Dolor<T>
+where
+ T: Eq,
+{
+ sit: T,
}
```
-## `binop_separator` (tracking issue #3368)
-
-Where to put a binary operator when a binary expression goes multiline.
-
-- **Default value**: `"Front"`
-- **Possible values**: `"Front"`, `"Back"`
-- **Stable**: No
-
-#### `"Front"` (default):
+#### `"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,
}
```
-#### `"Back"`:
-```rust
-fn main() {
- let or = foofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoo ||
- barbarbarbarbarbarbarbarbarbarbarbarbarbarbarbar;
+## `color`
- let sum = 123456789012345678901234567890 +
- 123456789012345678901234567890 +
- 123456789012345678901234567890;
+Whether to use colored output or not.
- let range = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa..
- bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;
-}
-```
+- **Default value**: `"Auto"`
+- **Possible values**: "Auto", "Always", "Never"
+- **Stable**: No (tracking issue: #3385)
-## `combine_control_expr` (tracking issue #3369)
+## `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):
}
```
-## `comment_width` (tracking issue #3349)
+## `comment_width`
Maximum length of comments. No effect unless`wrap_comments = true`.
- **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.
See also [`wrap_comments`](#wrap_comments).
-## `condense_wildcard_suffixes` (tracking issue #3384)
+## `condense_wildcard_suffixes`
Replace strings of _ wildcards by a single .. in tuple patterns
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3384)
#### `false` (default):
}
```
-## `control_brace_style` (tracking issue #3377)
+## `control_brace_style`
+
+Brace style for control flow constructs
+
+- **Default value**: `"AlwaysSameLine"`
+- **Possible values**: `"AlwaysNextLine"`, `"AlwaysSameLine"`, `"ClosingNextLine"`
+- **Stable**: No (tracking issue: #3377)
+
+#### `"AlwaysSameLine"` (default):
+
+```rust
+fn main() {
+ if lorem {
+ println!("ipsum!");
+ } else {
+ println!("dolor!");
+ }
+}
+```
+
+#### `"AlwaysNextLine"`:
+
+```rust
+fn main() {
+ if lorem
+ {
+ println!("ipsum!");
+ }
+ else
+ {
+ println!("dolor!");
+ }
+}
+```
+
+#### `"ClosingNextLine"`:
+
+```rust
+fn main() {
+ if lorem {
+ println!("ipsum!");
+ }
+ else {
+ println!("dolor!");
+ }
+}
+```
+
+## `disable_all_formatting`
+
+Don't reformat anything
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **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).
+
-Brace style for control flow constructs
+## `enum_discrim_align_threshold`
-- **Default value**: `"AlwaysSameLine"`
-- **Possible values**: `"AlwaysNextLine"`, `"AlwaysSameLine"`, `"ClosingNextLine"`
-- **Stable**: No
+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.
-#### `"AlwaysSameLine"` (default):
+Note that this is not how much whitespace is inserted, but instead the longest variant name that
+doesn't get ignored when aligning.
-```rust
-fn main() {
- if lorem {
- println!("ipsum!");
- } else {
- println!("dolor!");
- }
-}
-```
+- **Default value** : 0
+- **Possible values**: any positive integer
+- **Stable**: No (tracking issue: #3372)
-#### `"AlwaysNextLine"`:
+#### `0` (default):
```rust
-fn main() {
- if lorem
- {
- println!("ipsum!");
- }
- else
- {
- println!("dolor!");
- }
+enum Bar {
+ A = 0,
+ Bb = 1,
+ RandomLongVariantGoesHere = 10,
+ Ccc = 71,
+}
+
+enum Bar {
+ VeryLongVariantNameHereA = 0,
+ VeryLongVariantNameHereBb = 1,
+ VeryLongVariantNameHereCcc = 2,
}
```
-#### `"ClosingNextLine"`:
+#### `20`:
```rust
-fn main() {
- if lorem {
- println!("ipsum!");
- }
- else {
- println!("dolor!");
- }
+enum Foo {
+ A = 0,
+ Bb = 1,
+ RandomLongVariantGoesHere = 10,
+ Ccc = 2,
}
-```
-
-## `disable_all_formatting` (tracking issue #3388)
-Don't reformat anything
+enum Bar {
+ VeryLongVariantNameHereA = 0,
+ VeryLongVariantNameHereBb = 1,
+ VeryLongVariantNameHereCcc = 2,
+}
+```
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
-## `error_on_line_overflow` (tracking issue #3391)
+## `error_on_line_overflow`
Error if Rustfmt is unable to get all lines within `max_width`, except for comments and string
literals. If this happens, then it is a bug in Rustfmt. You might be able to work around the bug by
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3391)
See also [`max_width`](#max_width).
-## `error_on_unformatted` (tracking issue #3392)
+## `error_on_unformatted`
Error if unable to get comments or string literals within `max_width`, or they are left with
trailing whitespaces.
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3392)
-## `fn_args_density` (tracking issue #3375)
+## `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):
dolor: Dolor,
sit: Sit,
amet: Amet,
- consectetur: Consectetur,
- adipiscing: Adipiscing,
- elit: Elit,
- ) {
- // body
- }
-}
-```
-
-#### `"Compressed"`:
-
-```rust
-trait Lorem {
- fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet);
-
- fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet) {
- // body
- }
-
- fn lorem(
- ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet, consectetur: Consectetur,
- adipiscing: Adipiscing, elit: Elit,
- );
-
- fn lorem(
- ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet, consectetur: Consectetur,
- adipiscing: Adipiscing, elit: Elit,
- ) {
- // body
- }
-}
-```
-
-#### `"Vertical"`:
-
-```rust
-trait Lorem {
- fn lorem(
- ipsum: Ipsum,
- dolor: Dolor,
- sit: Sit,
- amet: Amet,
- );
-
- fn lorem(
- ipsum: Ipsum,
- dolor: Dolor,
- sit: Sit,
- amet: Amet,
- ) {
- // body
- }
-
- fn lorem(
- ipsum: Ipsum,
- dolor: Dolor,
- sit: Sit,
- amet: Amet,
- consectetur: Consectetur,
- adipiscing: Adipiscing,
- elit: Elit,
- );
-
- fn lorem(
- ipsum: Ipsum,
- dolor: Dolor,
- sit: Sit,
- amet: Amet,
- consectetur: Consectetur,
- adipiscing: Adipiscing,
- elit: Elit,
- ) {
- // body
- }
-}
-```
-
-
-## `brace_style` (tracking issue #3376)
-
-Brace style for items
-
-- **Default value**: `"SameLineWhere"`
-- **Possible values**: `"AlwaysNextLine"`, `"PreferSameLine"`, `"SameLineWhere"`
-- **Stable**: No
-
-### Functions
-
-#### `"SameLineWhere"` (default):
-
-```rust
-fn lorem() {
- // body
-}
-
-fn lorem(ipsum: usize) {
- // body
-}
-
-fn lorem<T>(ipsum: T)
-where
- T: Add + Sub + Mul + Div,
-{
- // body
-}
-```
-
-#### `"AlwaysNextLine"`:
-
-```rust
-fn lorem()
-{
- // body
-}
-
-fn lorem(ipsum: usize)
-{
- // body
-}
-
-fn lorem<T>(ipsum: T)
-where
- T: Add + Sub + Mul + Div,
-{
- // body
-}
-```
-
-#### `"PreferSameLine"`:
-
-```rust
-fn lorem() {
- // body
-}
-
-fn lorem(ipsum: usize) {
- // body
-}
-
-fn lorem<T>(ipsum: T)
-where
- T: Add + Sub + Mul + Div, {
- // body
-}
-```
-
-### Structs and enums
-
-#### `"SameLineWhere"` (default):
-
-```rust
-struct Lorem {
- ipsum: bool,
-}
-
-struct Dolor<T>
-where
- T: Eq,
-{
- sit: T,
-}
-```
-
-#### `"AlwaysNextLine"`:
-
-```rust
-struct Lorem
-{
- ipsum: bool,
-}
-
-struct Dolor<T>
-where
- T: Eq,
-{
- sit: T,
-}
-```
-
-#### `"PreferSameLine"`:
-
-```rust
-struct Lorem {
- ipsum: bool,
-}
-
-struct Dolor<T>
-where
- T: Eq, {
- sit: T,
+ consectetur: Consectetur,
+ adipiscing: Adipiscing,
+ elit: Elit,
+ ) {
+ // body
+ }
}
```
-
-## `empty_item_single_line` (tracking issue #3356)
-
-Put empty-body functions and impls on a single line
-
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-- **Stable**: No
-
-#### `true` (default):
+#### `"Compressed"`:
```rust
-fn lorem() {}
-
-impl Lorem {}
-```
+trait Lorem {
+ fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet);
-#### `false`:
+ fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet) {
+ // body
+ }
-```rust
-fn lorem() {
-}
+ fn lorem(
+ ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet, consectetur: Consectetur,
+ adipiscing: Adipiscing, elit: Elit,
+ );
-impl Lorem {
+ fn lorem(
+ ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet, consectetur: Consectetur,
+ adipiscing: Adipiscing, elit: Elit,
+ ) {
+ // body
+ }
}
```
-See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
-
-
-## `enum_discrim_align_threshold` (tracking issue #3372)
-
-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
-
-#### `0` (default):
+#### `"Vertical"`:
```rust
-enum Bar {
- A = 0,
- Bb = 1,
- RandomLongVariantGoesHere = 10,
- Ccc = 71,
-}
-
-enum Bar {
- VeryLongVariantNameHereA = 0,
- VeryLongVariantNameHereBb = 1,
- VeryLongVariantNameHereCcc = 2,
-}
-```
+trait Lorem {
+ fn lorem(
+ ipsum: Ipsum,
+ dolor: Dolor,
+ sit: Sit,
+ amet: Amet,
+ );
-#### `20`:
+ fn lorem(
+ ipsum: Ipsum,
+ dolor: Dolor,
+ sit: Sit,
+ amet: Amet,
+ ) {
+ // body
+ }
-```rust
-enum Foo {
- A = 0,
- Bb = 1,
- RandomLongVariantGoesHere = 10,
- Ccc = 2,
-}
+ fn lorem(
+ ipsum: Ipsum,
+ dolor: Dolor,
+ sit: Sit,
+ amet: Amet,
+ consectetur: Consectetur,
+ adipiscing: Adipiscing,
+ elit: Elit,
+ );
-enum Bar {
- VeryLongVariantNameHereA = 0,
- VeryLongVariantNameHereBb = 1,
- VeryLongVariantNameHereCcc = 2,
+ fn lorem(
+ ipsum: Ipsum,
+ dolor: Dolor,
+ sit: Sit,
+ amet: Amet,
+ consectetur: Consectetur,
+ adipiscing: Adipiscing,
+ elit: Elit,
+ ) {
+ // body
+ }
}
```
-## `fn_single_line` (tracking issue #3358)
+## `fn_single_line`
Put single-expression functions on a single line
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3358)
#### `false` (default):
See also [`control_brace_style`](#control_brace_style).
-## `where_single_line` (tracking issue #3359)
-
-Forces the `where` clause to be laid out on a single line.
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
-
-#### `false` (default):
-
-```rust
-impl<T> Lorem for T
-where
- Option<T>: Ipsum,
-{
- // body
-}
-```
-
-#### `true`:
-
-```rust
-impl<T> Lorem for T
-where Option<T>: Ipsum
-{
- // body
-}
-```
-
-See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
-
-
## `force_explicit_abi`
Always print the abi for extern items
}
```
-## `format_strings` (tracking issue #3353)
+## `force_multiline_blocks`
-Format string literals where necessary
+Force multiline closure and match arm bodies to be wrapped in a block
- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Possible values**: `false`, `true`
+- **Stable**: No (tracking issue: #3374)
#### `false` (default):
```rust
fn main() {
- let lorem = "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet consectetur adipiscing";
+ result.and_then(|maybe_value| match maybe_value {
+ None => foo(),
+ Some(value) => bar(),
+ });
+
+ match lorem {
+ None => |ipsum| {
+ println!("Hello World");
+ },
+ Some(dolor) => foo(),
+ }
}
```
```rust
fn main() {
- let lorem = "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet \
- consectetur adipiscing";
+ result.and_then(|maybe_value| {
+ match maybe_value {
+ None => foo(),
+ Some(value) => bar(),
+ }
+ });
+
+ match lorem {
+ None => {
+ |ipsum| {
+ println!("Hello World");
+ }
+ }
+ Some(dolor) => foo(),
+ }
}
```
-See also [`max_width`](#max_width).
-## `format_macro_matchers` (tracking issue #3354)
+## `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
+}
+```
+
+#### `true`
+
+```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
+- **Stable**: No (tracking issue: #3354)
#### `false` (default):
See also [`format_macro_bodies`](#format_macro_bodies).
-## `format_macro_bodies` (tracking issue #3355)
+## `format_macro_bodies`
Format the bodies of macros.
- **Default value**: `true`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3355)
+
+#### `true` (default):
+
+```rust
+macro_rules! foo {
+ ($a: ident : $b: ty) => {
+ $a(42): $b;
+ };
+ ($a: ident $b: ident $c: ident) => {
+ $a = $b + $c;
+ };
+}
+```
+
+#### `false`:
+
+```rust
+macro_rules! foo {
+ ($a: ident : $b: ty) => { $a(42): $b; };
+ ($a: ident $b: ident $c: ident) => { $a=$b+$c; };
+}
+```
+
+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)
-#### `true` (default):
+#### `false` (default):
```rust
-macro_rules! foo {
- ($a: ident : $b: ty) => {
- $a(42): $b;
- };
- ($a: ident $b: ident $c: ident) => {
- $a = $b + $c;
- };
+fn main() {
+ let lorem = "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet consectetur adipiscing";
}
```
-#### `false`:
+#### `true`:
```rust
-macro_rules! foo {
- ($a: ident : $b: ty) => { $a(42): $b; };
- ($a: ident $b: ident $c: ident) => { $a=$b+$c; };
+fn main() {
+ let lorem = "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet \
+ consectetur adipiscing";
}
```
-See also [`format_macro_matchers`](#format_macro_matchers).
-
+See also [`max_width`](#max_width).
## `hard_tabs`
See also: [`tab_spaces`](#tab_spaces).
-## `imports_indent` (tracking issue #3360)
+## `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
+- **Stable**: No (tracking issue: #3360)
#### `"Block"` (default):
See also: [`imports_layout`](#imports_layout).
-## `imports_layout` (tracking issue #3361)
+## `imports_layout`
Item layout inside a imports block
- **Default value**: "Mixed"
- **Possible values**: "Horizontal", "HorizontalVertical", "Mixed", "Vertical"
-- **Stable**: No
+- **Stable**: No (tracking issue: #3361)
#### `"Mixed"` (default):
};
```
-## `merge_imports` (tracking issue #3362)
+## `indent_style`
-Merge multiple imports into a single nested import.
+Indent on expressions or items.
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Default value**: `"Block"`
+- **Possible values**: `"Block"`, `"Visual"`
+- **Stable**: No (tracking issue: #3346)
-#### `false` (default):
+### Array
+
+#### `"Block"` (default):
```rust
-use foo::{a, c, d};
-use foo::{b, g};
-use foo::{e, f};
+fn main() {
+ let lorem = vec![
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit",
+ ];
+}
```
-#### `true`:
+#### `"Visual"`:
```rust
-use foo::{a, b, c, d, e, f, g};
+fn main() {
+ let lorem = vec!["ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit"];
+}
```
+### Control flow
-## `match_block_trailing_comma` (tracking issue #3380)
-
-Put a trailing comma after a block based match arm (non-block arms are not affected)
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
-
-#### `false` (default):
+#### `"Block"` (default):
```rust
fn main() {
- match lorem {
- Lorem::Ipsum => {
- println!("ipsum");
- }
- Lorem::Dolor => println!("dolor"),
+ if lorem_ipsum
+ && dolor_sit
+ && amet_consectetur
+ && lorem_sit
+ && dolor_consectetur
+ && amet_ipsum
+ && lorem_consectetur
+ {
+ // ...
}
}
```
-#### `true`:
+#### `"Visual"`:
```rust
fn main() {
- match lorem {
- Lorem::Ipsum => {
- println!("ipsum");
- },
- Lorem::Dolor => println!("dolor"),
+ if lorem_ipsum
+ && dolor_sit
+ && amet_consectetur
+ && lorem_sit
+ && dolor_consectetur
+ && amet_ipsum
+ && lorem_consectetur
+ {
+ // ...
}
}
```
-See also: [`trailing_comma`](#trailing_comma), [`match_arm_blocks`](#match_arm_blocks).
+See also: [`control_brace_style`](#control_brace_style).
-## `max_width`
+### Function arguments
-Maximum width of each line
+#### `"Block"` (default):
-- **Default value**: `100`
-- **Possible values**: any positive integer
-- **Stable**: Yes
+```rust
+fn lorem() {}
-See also [`error_on_line_overflow`](#error_on_line_overflow).
+fn lorem(ipsum: usize) {}
-## `merge_derives`
+fn lorem(
+ ipsum: usize,
+ dolor: usize,
+ sit: usize,
+ amet: usize,
+ consectetur: usize,
+ adipiscing: usize,
+ elit: usize,
+) {
+ // body
+}
+```
-Merge multiple derives into a single one.
+#### `"Visual"`:
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
+```rust
+fn lorem() {}
-#### `true` (default):
+fn lorem(ipsum: usize) {}
+
+fn lorem(ipsum: usize,
+ dolor: usize,
+ sit: usize,
+ amet: usize,
+ consectetur: usize,
+ adipiscing: usize,
+ elit: usize) {
+ // body
+}
+```
+
+### Function calls
+
+#### `"Block"` (default):
```rust
-#[derive(Eq, PartialEq, Debug, Copy, Clone)]
-pub enum Foo {}
+fn main() {
+ lorem(
+ "lorem",
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit",
+ );
+}
```
-#### `false`:
+#### `"Visual"`:
```rust
-#[derive(Eq, PartialEq)]
-#[derive(Debug)]
-#[derive(Copy, Clone)]
-pub enum Foo {}
+fn main() {
+ lorem("lorem",
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit");
+}
+```
+
+### Generics
+
+#### `"Block"` (default):
+
+```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
+}
+```
+
+#### `"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
+}
```
-## `force_multiline_blocks` (tracking issue #3374)
-
-Force multiline closure and match arm bodies to be wrapped in a block
-
-- **Default value**: `false`
-- **Possible values**: `false`, `true`
-- **Stable**: No
+#### Struct
-#### `false` (default):
+#### `"Block"` (default):
```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(),
- }
+ let lorem = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
}
```
-#### `true`:
+#### `"Visual"`:
```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(),
- }
+ let lorem = Lorem { ipsum: dolor,
+ sit: amet };
}
```
+See also: [`struct_lit_single_line`](#struct_lit_single_line), [`indent_style`](#indent_style).
-## `newline_style`
-
-Unix or Windows line endings
-
-- **Default value**: `"Auto"`
-- **Possible values**: `"Auto"`, `"Native"`, `"Unix"`, `"Windows"`
-- **Stable**: Yes
-
-#### `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` (tracking issue #3350)
-
-Convert /* */ comments to // comments where possible
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+### Where predicates
-#### `false` (default):
+#### `"Block"` (default):
```rust
-// Lorem ipsum:
-fn dolor() -> usize {}
-
-/* sit amet: */
-fn adipiscing() -> usize {}
+fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
+where
+ Ipsum: Eq,
+ Dolor: Eq,
+ Sit: Eq,
+ Amet: Eq,
+{
+ // body
+}
```
-#### `true`:
+#### `"Visual"`:
```rust
-// Lorem ipsum:
-fn dolor() -> usize {}
-
-// sit amet:
-fn adipiscing() -> usize {}
+fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
+ where Ipsum: Eq,
+ Dolor: Eq,
+ Sit: Eq,
+ Amet: Eq
+{
+ // body
+}
```
-## `remove_nested_parens`
+## `inline_attribute_width`
-Remove nested parens.
+Write an item and its attribute on the same line if their combined width is below a threshold
-- **Default value**: `true`,
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
+- **Default value**: 0
+- **Possible values**: any positive integer
+- **Stable**: No (tracking issue: #3343)
+### Example
-#### `true` (default):
+#### `0` (default):
```rust
-fn main() {
- (foo());
-}
+#[cfg(feature = "alloc")]
+use core::slice;
```
-#### `false`:
+#### `50`:
```rust
-fn main() {
- ((((foo()))));
-}
+#[cfg(feature = "alloc")] use core::slice;
```
+## `license_template_path`
-## `reorder_imports`
-
-Reorder import and extern crate statements alphabetically in groups (a group is
-separated by a newline).
+Check whether beginnings of files match a license template.
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
+- **Default value**: `""`
+- **Possible values**: path to a license template file
+- **Stable**: No (tracking issue: #3352)
-#### `true` (default):
+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.:
-```rust
-use dolor;
-use ipsum;
-use lorem;
-use sit;
```
-
-#### `false`:
-
-```rust
-use lorem;
-use ipsum;
-use dolor;
-use sit;
+// Copyright {\d+} The Rust Project Developers.
```
+`\{`, `\}` and `\\` match literal braces / backslashes.
-## `reorder_modules`
+## `match_arm_blocks`
-Reorder `mod` declarations alphabetically in group.
+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**: Yes
+- **Stable**: No (tracking issue: #3373)
-#### `true` (default)
+#### `true` (default):
```rust
-mod a;
-mod b;
-
-mod dolor;
-mod ipsum;
-mod lorem;
-mod sit;
+fn main() {
+ match lorem {
+ true => {
+ foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x)
+ }
+ false => println!("{}", sit),
+ }
+}
```
-#### `false`
+#### `false`:
```rust
-mod b;
-mod a;
-
-mod lorem;
-mod ipsum;
-mod dolor;
-mod sit;
+fn main() {
+ match lorem {
+ true =>
+ foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x),
+ false => println!("{}", sit),
+ }
+}
```
-**Note** `mod` with `#[macro_export]` will not be reordered since that could change the semantics
-of the original source code.
+See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
-## `reorder_impl_items` (tracking issue #3363)
+## `match_block_trailing_comma`
-Reorder impl items. `type` and `const` are put first, then macros and methods.
+Put a trailing comma after a block based match arm (non-block arms are not affected)
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3380)
-#### `false` (default)
+#### `false` (default):
```rust
-struct Dummy;
-
-impl Iterator for Dummy {
- fn next(&mut self) -> Option<Self::Item> {
- None
+fn main() {
+ match lorem {
+ Lorem::Ipsum => {
+ println!("ipsum");
+ }
+ Lorem::Dolor => println!("dolor"),
}
-
- type Item = i32;
}
```
-#### `true`
+#### `true`:
```rust
-struct Dummy;
-
-impl Iterator for Dummy {
- type Item = i32;
-
- fn next(&mut self) -> Option<Self::Item> {
- None
+fn main() {
+ match lorem {
+ Lorem::Ipsum => {
+ println!("ipsum");
+ },
+ Lorem::Dolor => println!("dolor"),
}
}
```
-## `report_todo` (tracking issue #3393)
-
-Report `TODO` items in comments.
-
-- **Default value**: `"Never"`
-- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
-- **Stable**: No
-
-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
-`TODO`, `"Unnumbered"` will ignore it.
-
-See also [`report_fixme`](#report_fixme).
-
-## `report_fixme` (tracking issue #3394)
-
-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.
-
-See also [`report_todo`](#report_todo).
+See also: [`trailing_comma`](#trailing_comma), [`match_arm_blocks`](#match_arm_blocks).
+## `max_width`
-## `skip_children` (tracking issue #3389)
+Maximum width of each line
-Don't reformat out of line modules
+- **Default value**: `100`
+- **Possible values**: any positive integer
+- **Stable**: Yes
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+See also [`error_on_line_overflow`](#error_on_line_overflow).
-## `space_after_colon` (tracking issue #3366)
+## `merge_derives`
-Leave a space after the colon.
+Merge multiple derives into a single one.
- **Default value**: `true`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: Yes
#### `true` (default):
```rust
-fn lorem<T: Eq>(t: T) {
- let lorem: Dolor = Lorem {
- ipsum: dolor,
- sit: amet,
- };
-}
+#[derive(Eq, PartialEq, Debug, Copy, Clone)]
+pub enum Foo {}
```
#### `false`:
```rust
-fn lorem<T:Eq>(t:T) {
- let lorem:Dolor = Lorem {
- ipsum:dolor,
- sit:amet,
- };
-}
+#[derive(Eq, PartialEq)]
+#[derive(Debug)]
+#[derive(Copy, Clone)]
+pub enum Foo {}
```
-See also: [`space_before_colon`](#space_before_colon).
-
-## `space_before_colon` (tracking issue #3365)
+## `merge_imports`
-Leave a space before the colon.
+Merge multiple imports into a single nested import.
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3362)
#### `false` (default):
```rust
-fn lorem<T: Eq>(t: T) {
- let lorem: Dolor = Lorem {
- ipsum: dolor,
- sit: amet,
- };
-}
+use foo::{a, c, d};
+use foo::{b, g};
+use foo::{e, f};
```
#### `true`:
```rust
-fn lorem<T : Eq>(t : T) {
- let lorem : Dolor = Lorem {
- ipsum : dolor,
- sit : amet,
- };
-}
+use foo::{a, b, c, d, e, f, g};
```
-See also: [`space_after_colon`](#space_after_colon).
-## `struct_field_align_threshold` (tracking issue #3371)
+## `newline_style`
-The maximum diff of width between struct fields to be aligned with each other.
+Unix or Windows line endings
-- **Default value** : 0
-- **Possible values**: any positive integer
-- **Stable**: No
+- **Default value**: `"Auto"`
+- **Possible values**: `"Auto"`, `"Native"`, `"Unix"`, `"Windows"`
+- **Stable**: Yes
-#### `0` (default):
+#### `Auto` (default):
-```rust
-struct Foo {
- x: u32,
- yy: u32,
- zzz: u32,
-}
-```
+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.
-#### `20`:
+#### `Native`
-```rust
-struct Foo {
- x: u32,
- yy: u32,
- zzz: u32,
-}
-```
+Line endings will be converted to `\r\n` on Windows and `\n` on all
+other platforms.
+
+#### `Unix`
-## `spaces_around_ranges` (tracking issue #3367)
+Line endings will be converted to `\n`.
-Put spaces around the .., ..=, and ... range operators
+#### `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
+- **Stable**: No (tracking issue: #3350)
#### `false` (default):
```rust
-fn main() {
- let lorem = 0..10;
- let ipsum = 0..=10;
-
- match lorem {
- 1..5 => foo(),
- _ => bar,
- }
-
- match lorem {
- 1..=5 => foo(),
- _ => bar,
- }
+// Lorem ipsum:
+fn dolor() -> usize {}
- match lorem {
- 1...5 => foo(),
- _ => bar,
- }
-}
+/* sit amet: */
+fn adipiscing() -> usize {}
```
#### `true`:
```rust
-fn main() {
- let lorem = 0 .. 10;
- let ipsum = 0 ..= 10;
-
- match lorem {
- 1 .. 5 => foo(),
- _ => bar,
- }
-
- match lorem {
- 1 ..= 5 => foo(),
- _ => bar,
- }
+// Lorem ipsum:
+fn dolor() -> usize {}
- match lorem {
- 1 ... 5 => foo(),
- _ => bar,
- }
-}
+// sit amet:
+fn adipiscing() -> usize {}
```
-## `struct_lit_single_line` (tracking issue #3357)
+## `normalize_doc_attributes`
-Put small struct literals on a single line
+Convert `#![doc]` and `#[doc]` attributes to `//!` and `///` doc comments.
-- **Default value**: `true`
+- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3351)
-#### `true` (default):
+#### `false` (default):
```rust
-fn main() {
- let lorem = Lorem { foo: bar, baz: ofo };
-}
+#![doc = "Example documentation"]
+
+#[doc = "Example item documentation"]
+pub enum Foo {}
```
-#### `false`:
+#### `true`:
```rust
-fn main() {
- let lorem = Lorem {
- foo: bar,
- baz: ofo,
- };
-}
-```
-
-See also: [`indent_style`](#indent_style).
+//! Example documentation
+/// Example item documentation
+pub enum Foo {}
+```
-## `tab_spaces`
+## `overflow_delimited_expr`
-Number of spaces per tab
+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**: `4`
-- **Possible values**: any positive integer
-- **Stable**: Yes
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3370)
-#### `4` (default):
+#### `false` (default):
```rust
-fn lorem() {
- let ipsum = dolor();
- let sit = vec![
- "amet consectetur adipiscing elit amet",
- "consectetur adipiscing elit amet consectetur.",
- ];
-}
-```
+fn example() {
+ foo(ctx, |param| {
+ action();
+ foo(param)
+ });
-#### `2`:
+ foo(
+ ctx,
+ Bar {
+ x: value,
+ y: value2,
+ },
+ );
-```rust
-fn lorem() {
- let ipsum = dolor();
- let sit = vec![
- "amet consectetur adipiscing elit amet",
- "consectetur adipiscing elit amet consectetur.",
- ];
+ 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,
+ ],
+ );
}
```
-See also: [`hard_tabs`](#hard_tabs).
-
-
-## `trailing_comma` (tracking issue #3379)
-
-How to handle trailing commas for lists
+#### `true`:
-- **Default value**: `"Vertical"`
-- **Possible values**: `"Always"`, `"Never"`, `"Vertical"`
-- **Stable**: No
+```rust
+fn example() {
+ foo(ctx, |param| {
+ action();
+ foo(param)
+ });
-#### `"Vertical"` (default):
+ foo(ctx, Bar {
+ x: value,
+ y: value2,
+ });
-```rust
-fn main() {
- let Lorem { ipsum, dolor, sit } = amet;
- let Lorem {
- ipsum,
- dolor,
- sit,
- amet,
- consectetur,
- adipiscing,
- } = elit;
+ 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,
+ ]);
}
```
-#### `"Always"`:
+## `remove_nested_parens`
+
+Remove nested parens.
+
+- **Default value**: `true`,
+- **Possible values**: `true`, `false`
+- **Stable**: Yes
+
+#### `true` (default):
```rust
fn main() {
- let Lorem { ipsum, dolor, sit, } = amet;
- let Lorem {
- ipsum,
- dolor,
- sit,
- amet,
- consectetur,
- adipiscing,
- } = elit;
+ (foo());
}
```
-#### `"Never"`:
-
+#### `false`:
```rust
fn main() {
- let Lorem { ipsum, dolor, sit } = amet;
- let Lorem {
- ipsum,
- dolor,
- sit,
- amet,
- consectetur,
- adipiscing
- } = elit;
+ ((((foo()))));
}
```
-See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
-## `trailing_semicolon` (tracking issue #3378)
+## `reorder_impl_items`
-Add trailing semicolon after break, continue and return
+Reorder impl items. `type` and `const` are put first, then macros and methods.
-- **Default value**: `true`
+- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3363)
+
+#### `false` (default)
-#### `true` (default):
```rust
-fn foo() -> usize {
- return 0;
+struct Dummy;
+
+impl Iterator for Dummy {
+ fn next(&mut self) -> Option<Self::Item> {
+ None
+ }
+
+ type Item = i32;
}
```
-#### `false`:
+#### `true`
+
```rust
-fn foo() -> usize {
- return 0
+struct Dummy;
+
+impl Iterator for Dummy {
+ type Item = i32;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ None
+ }
}
```
-## `type_punctuation_density` (tracking issue #3364)
+## `reorder_imports`
-Determines if `+` or `=` are wrapped in spaces in the punctuation of types
+Reorder import and extern crate statements alphabetically in groups (a group is
+separated by a newline).
-- **Default value**: `"Wide"`
-- **Possible values**: `"Compressed"`, `"Wide"`
-- **Stable**: No
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: Yes
-#### `"Wide"` (default):
+#### `true` (default):
```rust
-fn lorem<Ipsum: Dolor + Sit = Amet>() {
- // body
-}
+use dolor;
+use ipsum;
+use lorem;
+use sit;
```
-#### `"Compressed"`:
+#### `false`:
```rust
-fn lorem<Ipsum: Dolor+Sit=Amet>() {
- // body
-}
+use lorem;
+use ipsum;
+use dolor;
+use sit;
```
-## `use_field_init_shorthand`
-Use field initialize shorthand if possible.
+## `reorder_modules`
-- **Default value**: `false`
+Reorder `mod` declarations alphabetically in group.
+
+- **Default value**: `true`
- **Possible values**: `true`, `false`
- **Stable**: Yes
-#### `false` (default):
+#### `true` (default)
```rust
-struct Foo {
- x: u32,
- y: u32,
- z: u32,
-}
+mod a;
+mod b;
-fn main() {
- let x = 1;
- let y = 2;
- let z = 3;
- let a = Foo { x: x, y: y, z: z };
-}
+mod dolor;
+mod ipsum;
+mod lorem;
+mod sit;
```
-#### `true`:
+#### `false`
```rust
-struct Foo {
- x: u32,
- y: u32,
- z: u32,
-}
+mod b;
+mod a;
-fn main() {
- let x = 1;
- let y = 2;
- let z = 3;
- let a = Foo { x, y, z };
-}
+mod lorem;
+mod ipsum;
+mod dolor;
+mod sit;
```
-## `use_try_shorthand`
+**Note** `mod` with `#[macro_export]` will not be reordered since that could change the semantics
+of the original source code.
-Replace uses of the try! macro by the ? shorthand
+## `report_fixme`
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
+Report `FIXME` items in comments.
-#### `false` (default):
+- **Default value**: `"Never"`
+- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
+- **Stable**: No (tracking issue: #3394)
-```rust
-fn main() {
- let lorem = try!(ipsum.map(|dolor| dolor.sit()));
-}
-```
+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.
-#### `true`:
+See also [`report_todo`](#report_todo).
-```rust
-fn main() {
- let lorem = ipsum.map(|dolor| dolor.sit())?;
-}
-```
-## `format_doc_comments` (tracking issue #3348)
+## `report_todo`
-Format doc comments.
+Report `TODO` items in comments.
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Default value**: `"Never"`
+- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
+- **Stable**: No (tracking issue: #3393)
-#### `false` (default):
+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
+`TODO`, `"Unnumbered"` will ignore it.
-```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
-}
-```
+See also [`report_fixme`](#report_fixme).
-#### `true`
+## `required_version`
-```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
-}
-```
+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)
-## `wrap_comments` (tracking issue #3347)
+## `skip_children`
-Break comments to fit on the line
+Don't reformat out of line modules
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3389)
-#### `false` (default):
+## `space_after_colon`
+
+Leave a space after the colon.
+
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3366)
+
+#### `true` (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.
+fn lorem<T: Eq>(t: T) {
+ let lorem: Dolor = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
+}
```
-#### `true`:
+#### `false`:
```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.
+fn lorem<T:Eq>(t:T) {
+ let lorem:Dolor = Lorem {
+ ipsum:dolor,
+ sit:amet,
+ };
+}
```
-## `match_arm_blocks`` (tracking issue #3373)
+See also: [`space_before_colon`](#space_before_colon).
-Wrap the body of arms in blocks when it does not fit on the same line with the pattern of arms
+## `space_before_colon`
-- **Default value**: `true`
+Leave a space before the colon.
+
+- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3365)
-#### `true` (default):
+#### `false` (default):
```rust
-fn main() {
- match lorem {
- true => {
- foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x)
- }
- false => println!("{}", sit),
- }
+fn lorem<T: Eq>(t: T) {
+ let lorem: Dolor = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
}
```
-#### `false`:
+#### `true`:
```rust
-fn main() {
- match lorem {
- true =>
- foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x),
- false => println!("{}", sit),
- }
+fn lorem<T : Eq>(t : T) {
+ let lorem : Dolor = Lorem {
+ ipsum : dolor,
+ sit : amet,
+ };
}
```
-See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
+See also: [`space_after_colon`](#space_after_colon).
-## `overflow_delimited_expr` (tracking issue #3370)
+## `spaces_around_ranges`
-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.
+Put spaces around the .., ..=, and ... range operators
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3367)
#### `false` (default):
```rust
-fn example() {
- foo(ctx, |param| {
- action();
- foo(param)
- });
+fn main() {
+ let lorem = 0..10;
+ let ipsum = 0..=10;
- foo(
- ctx,
- Bar {
- x: value,
- y: value2,
- },
- );
+ match lorem {
+ 1..5 => foo(),
+ _ => bar,
+ }
- foo(
- ctx,
- &[
- MAROON_TOMATOES,
- PURPLE_POTATOES,
- ORGANE_ORANGES,
- GREEN_PEARS,
- RED_APPLES,
- ],
- );
+ match lorem {
+ 1..=5 => foo(),
+ _ => bar,
+ }
- foo(
- ctx,
- vec![
- MAROON_TOMATOES,
- PURPLE_POTATOES,
- ORGANE_ORANGES,
- GREEN_PEARS,
- RED_APPLES,
- ],
- );
+ match lorem {
+ 1...5 => foo(),
+ _ => bar,
+ }
}
```
#### `true`:
```rust
-fn example() {
- foo(ctx, |param| {
- action();
- foo(param)
- });
+fn main() {
+ let lorem = 0 .. 10;
+ let ipsum = 0 ..= 10;
- foo(ctx, Bar {
- x: value,
- y: value2,
- });
+ match lorem {
+ 1 .. 5 => foo(),
+ _ => bar,
+ }
- foo(ctx, &[
- MAROON_TOMATOES,
- PURPLE_POTATOES,
- ORGANE_ORANGES,
- GREEN_PEARS,
- RED_APPLES,
- ]);
+ match lorem {
+ 1 ..= 5 => foo(),
+ _ => bar,
+ }
- foo(ctx, vec![
- MAROON_TOMATOES,
- PURPLE_POTATOES,
- ORGANE_ORANGES,
- GREEN_PEARS,
- RED_APPLES,
- ]);
+ match lorem {
+ 1 ... 5 => foo(),
+ _ => bar,
+ }
}
```
-## `blank_lines_upper_bound` (tracking issue #3381)
+## `struct_field_align_threshold`
-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.
+The maximum diff of width between struct fields to be aligned with each other.
-- **Default value**: `1`
-- **Possible values**: *unsigned integer*
-- **Stable**: No
+- **Default value** : 0
+- **Possible values**: any non-negative integer
+- **Stable**: No (tracking issue: #3371)
-### Example
-Original Code:
+#### `0` (default):
```rust
-#![rustfmt::skip]
+struct Foo {
+ x: u32,
+ yy: u32,
+ zzz: u32,
+}
+```
-fn foo() {
- println!("a");
+#### `20`:
+
+```rust
+struct Foo {
+ x: u32,
+ yy: u32,
+ zzz: u32,
}
+```
+## `struct_lit_single_line`
+Put small struct literals on a single line
-fn bar() {
- println!("b");
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3357)
+#### `true` (default):
- println!("c");
+```rust
+fn main() {
+ let lorem = Lorem { foo: bar, baz: ofo };
}
```
-#### `1` (default):
+#### `false`:
+
```rust
-fn foo() {
- println!("a");
+fn main() {
+ let lorem = Lorem {
+ foo: bar,
+ baz: ofo,
+ };
}
+```
-fn bar() {
- println!("b");
+See also: [`indent_style`](#indent_style).
- println!("c");
+
+## `tab_spaces`
+
+Number of spaces per tab
+
+- **Default value**: `4`
+- **Possible values**: any positive integer
+- **Stable**: Yes
+
+#### `4` (default):
+
+```rust
+fn lorem() {
+ let ipsum = dolor();
+ let sit = vec![
+ "amet consectetur adipiscing elit amet",
+ "consectetur adipiscing elit amet consectetur.",
+ ];
}
```
#### `2`:
+
```rust
-fn foo() {
- println!("a");
+fn lorem() {
+ let ipsum = dolor();
+ let sit = vec![
+ "amet consectetur adipiscing elit amet",
+ "consectetur adipiscing elit amet consectetur.",
+ ];
}
+```
+See also: [`hard_tabs`](#hard_tabs).
-fn bar() {
- println!("b");
+## `trailing_comma`
- println!("c");
+How to handle trailing commas for lists
+
+- **Default value**: `"Vertical"`
+- **Possible values**: `"Always"`, `"Never"`, `"Vertical"`
+- **Stable**: No (tracking issue: #3379)
+
+#### `"Vertical"` (default):
+
+```rust
+fn main() {
+ let Lorem { ipsum, dolor, sit } = amet;
+ let Lorem {
+ ipsum,
+ dolor,
+ sit,
+ amet,
+ consectetur,
+ adipiscing,
+ } = elit;
}
```
-See also: [`blank_lines_lower_bound`](#blank_lines_lower_bound)
+#### `"Always"`:
+
+```rust
+fn main() {
+ let Lorem { ipsum, dolor, sit, } = amet;
+ let Lorem {
+ ipsum,
+ dolor,
+ sit,
+ amet,
+ consectetur,
+ adipiscing,
+ } = elit;
+}
+```
+
+#### `"Never"`:
+
+```rust
+fn main() {
+ let Lorem { ipsum, dolor, sit } = amet;
+ let Lorem {
+ ipsum,
+ dolor,
+ sit,
+ amet,
+ consectetur,
+ adipiscing
+ } = elit;
+}
+```
-## `blank_lines_lower_bound` (tracking issue #3382)
+See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
-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.
+## `trailing_semicolon`
-- **Default value**: `0`
-- **Possible values**: *unsigned integer*
-- **Stable**: No
+Add trailing semicolon after break, continue and return
-### Example
-Original Code (rustfmt will not change it with the default value of `0`):
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3378)
+#### `true` (default):
```rust
-#![rustfmt::skip]
-
-fn foo() {
- println!("a");
-}
-fn bar() {
- println!("b");
- println!("c");
+fn foo() -> usize {
+ return 0;
}
```
-#### `1`
+#### `false`:
```rust
-fn foo() {
-
- println!("a");
+fn foo() -> usize {
+ return 0
}
+```
-fn bar() {
+## `type_punctuation_density`
- println!("b");
+Determines if `+` or `=` are wrapped in spaces in the punctuation of types
- println!("c");
+- **Default value**: `"Wide"`
+- **Possible values**: `"Compressed"`, `"Wide"`
+- **Stable**: No (tracking issue: #3364)
+
+#### `"Wide"` (default):
+
+```rust
+fn lorem<Ipsum: Dolor + Sit = Amet>() {
+ // body
}
```
+#### `"Compressed"`:
+
+```rust
+fn lorem<Ipsum: Dolor+Sit=Amet>() {
+ // body
+}
+```
-## `required_version` (tracking issue #3386)
+## `unstable_features`
-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.
+Enable unstable features on the unstable channel.
-- **Default value**: `CARGO_PKG_VERSION`
-- **Possible values**: any published version (e.g. `"0.3.8"`)
-- **Stable**: No
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3387)
-## `hide_parse_errors` (tracking issue #3390)
+## `use_field_init_shorthand`
-Do not show parse errors if the parser failed to parse files.
+Use field initialize shorthand if possible.
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: Yes
-## `color` (tracking issue #3385)
+#### `false` (default):
-Whether to use colored output or not.
+```rust
+struct Foo {
+ x: u32,
+ y: u32,
+ z: u32,
+}
-- **Default value**: `"Auto"`
-- **Possible values**: "Auto", "Always", "Never"
-- **Stable**: No
+fn main() {
+ let x = 1;
+ let y = 2;
+ let z = 3;
+ let a = Foo { x: x, y: y, z: z };
+}
+```
-## `unstable_features` (tracking issue #3387)
+#### `true`:
-Enable unstable features on the unstable channel.
+```rust
+struct Foo {
+ x: u32,
+ y: u32,
+ z: u32,
+}
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+fn main() {
+ let x = 1;
+ let y = 2;
+ let z = 3;
+ let a = Foo { x, y, z };
+}
+```
-## `license_template_path` (tracking issue #3352)
+## `use_small_heuristics`
-Check whether beginnings of files match a license template.
+Whether to use different formatting for items and expressions if they satisfy a heuristic notion of 'small'.
-- **Default value**: `""``
-- **Possible values**: path to a license template file
-- **Stable**: No
+- **Default value**: `"Default"`
+- **Possible values**: `"Default"`, `"Off"`, `"Max"`
+- **Stable**: Yes
-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.:
+#### `Default` (default):
-```
-// Copyright {\d+} The Rust Project Developers.
-```
+```rust
+enum Lorem {
+ Ipsum,
+ Dolor(bool),
+ Sit { amet: Consectetur, adipiscing: Elit },
+}
-`\{`, `\}` and `\\` match literal braces / backslashes.
+fn main() {
+ lorem(
+ "lorem",
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ );
+
+ let lorem = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
+ let lorem = Lorem { ipsum: dolor };
-## `ignore` (tracking issue #3395)
+ let lorem = if ipsum { dolor } else { sit };
+}
+```
-Skip formatting the specified files and directories.
+#### `Off`:
-- **Default value**: format every files
-- **Possible values**: See an example below
-- **Stable**: No
+```rust
+enum Lorem {
+ Ipsum,
+ Dolor(bool),
+ Sit {
+ amet: Consectetur,
+ adipiscing: Elit,
+ },
+}
-### Example
+fn main() {
+ lorem("lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing");
-If you want to ignore specific files, put the following to your config file:
+ let lorem = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
-```toml
-ignore = [
- "src/types.rs",
- "src/foo/bar.rs",
-]
+ let lorem = if ipsum {
+ dolor
+ } else {
+ sit
+ };
+}
```
-If you want to ignore every file under `examples/`, put the following to your config file:
+#### `Max`:
-```toml
-ignore = [
- "examples",
-]
+```rust
+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 = if ipsum { dolor } else { sit };
+}
```
-## `edition`
+## `use_try_shorthand`
-Specifies which edition is used by the parser.
+Replace uses of the try! macro by the ? shorthand
-- **Default value**: `2015`
-- **Possible values**: `2015`, `2018`
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
- **Stable**: Yes
-### Example
+#### `false` (default):
+
+```rust
+fn main() {
+ let lorem = try!(ipsum.map(|dolor| dolor.sit()));
+}
+```
-If you want to format code that requires edition 2018, add the following to your config file:
+#### `true`:
-```toml
-edition = "2018"
+```rust
+fn main() {
+ let lorem = ipsum.map(|dolor| dolor.sit())?;
+}
```
-## `version` (tracking issue #3383)
+## `version`
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
- **Default value**: `One`
- **Possible values**: `One`, `Two`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3383)
### Example
version = "Two"
```
-## `normalize_doc_attributes` (tracking issue #3351)
+## `where_single_line`
-Convert `#![doc]` and `#[doc]` attributes to `//!` and `///` doc comments.
+Forces the `where` clause to be laid out on a single line.
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3359)
#### `false` (default):
```rust
-#![doc = "Example documentation"]
-
-#[doc = "Example item documentation"]
-pub enum Foo {}
+impl<T> Lorem for T
+where
+ Option<T>: Ipsum,
+{
+ // body
+}
```
#### `true`:
```rust
-//! Example documentation
+impl<T> Lorem for T
+where Option<T>: Ipsum
+{
+ // body
+}
+```
-/// Example item documentation
-pub enum Foo {}
+See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
+
+
+## `wrap_comments`
+
+Break comments to fit on the line
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3347)
+
+#### `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.
```
-## `emit_mode` (tracking issue #3399)
+# Internal Options
+
+## `emit_mode`
Internal option
-## `make_backup` (tracking issue #3400)
+## `make_backup`
Internal option, use `--backup`
+
+## `print_misformatted_file_names`
+
+Internal option, use `-l` or `--files-with-diff`
projects / rust.git / blobdiff