# 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`
+## `fn_single_line`
-Brace style for items
+Put single-expression functions on a single line
-- **Default value**: `"SameLineWhere"`
-- **Possible values**: `"AlwaysNextLine"`, `"PreferSameLine"`, `"SameLineWhere"`
-- **Stable**: No
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3358)
-### Functions
+#### `false` (default):
-#### `"SameLineWhere"` (default):
+```rust
+fn lorem() -> usize {
+ 42
+}
+
+fn lorem() -> usize {
+ let ipsum = 42;
+ ipsum
+}
+```
+
+#### `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;
}
```
-#### `"AlwaysNextLine"`:
+## `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
}
```
-#### `"PreferSameLine"`:
+#### `true`
```rust
-fn lorem() {
- // body
+/// 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
}
+```
-fn lorem(ipsum: usize) {
- // body
+## `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
+macro_rules! foo {
+ ($a: ident : $b: ty) => {
+ $a(42): $b;
+ };
+ ($a: ident $b: ident $c: ident) => {
+ $a = $b + $c;
+ };
}
+```
-fn lorem<T>(ipsum: T)
-where
- T: Add + Sub + Mul + Div, {
- // body
+#### `true`:
+
+```rust
+macro_rules! foo {
+ ($a:ident : $b:ty) => {
+ $a(42): $b;
+ };
+ ($a:ident $b:ident $c:ident) => {
+ $a = $b + $c;
+ };
}
```
-### Structs and enums
+See also [`format_macro_bodies`](#format_macro_bodies).
-#### `"SameLineWhere"` (default):
+
+## `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; };
}
```
-#### `"AlwaysNextLine"`:
+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
+fn main() {
+ let lorem = "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet consectetur adipiscing";
+}
+```
+
+#### `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
-```rust
-struct Lorem
-{
- ipsum: bool,
-}
+#### `false` (default):
-struct Dolor<T>
-where
- T: Eq,
-{
- sit: T,
+```rust
+fn lorem() -> usize {
+ 42 // spaces before 42
}
```
-#### `"PreferSameLine"`:
+#### `true`:
```rust
-struct Lorem {
- ipsum: bool,
-}
-
-struct Dolor<T>
-where
- T: Eq, {
- sit: T,
+fn lorem() -> usize {
+ 42 // tabs before 42
}
```
+See also: [`tab_spaces`](#tab_spaces).
-## `empty_item_single_line`
-Put empty-body functions and impls on a single line
+## `hide_parse_errors`
-- **Default value**: `true`
+Do not show parse errors if the parser failed to parse files.
+
+- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3390)
-#### `true` (default):
+## `ignore`
-```rust
-fn lorem() {}
+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.
-impl Lorem {}
-```
+- **Default value**: format every file
+- **Possible values**: See an example below
+- **Stable**: No (tracking issue: #3395)
-#### `false`:
+### Example
-```rust
-fn lorem() {
-}
+If you want to ignore specific files, put the following to your config file:
-impl Lorem {
-}
+```toml
+ignore = [
+ "src/types.rs",
+ "src/foo/bar.rs",
+]
```
-See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
+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:
-## `enum_discrim_align_threshold`
+```toml
+ignore = ["/"]
+```
-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.
+## `imports_indent`
-Note that this is not how much whitespace is inserted, but instead the longest variant name that
-doesn't get ignored when aligning.
+Indent style of imports
-- **Default value** : 0
-- **Possible values**: any positive integer
-- **Stable**: No
+- **Default Value**: `"Block"`
+- **Possible values**: `"Block"`, `"Visual"`
+- **Stable**: No (tracking issue: #3360)
-#### `0` (default):
+#### `"Block"` (default):
```rust
-enum Bar {
- A = 0,
- Bb = 1,
- RandomLongVariantGoesHere = 10,
- Ccc = 71,
-}
+use foo::{
+ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy,
+ zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
+};
+```
-enum Bar {
- VeryLongVariantNameHereA = 0,
- VeryLongVariantNameHereBb = 1,
- VeryLongVariantNameHereCcc = 2,
-}
+#### `"Visual"`:
+
+```rust
+use foo::{xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy,
+ zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz};
```
-#### `20`:
+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
-enum Foo {
- A = 0,
- Bb = 1,
- RandomLongVariantGoesHere = 10,
- Ccc = 2,
-}
+use foo::{xxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyy, zzzzzzzzzzzzzzzzzz};
-enum Bar {
- VeryLongVariantNameHereA = 0,
- VeryLongVariantNameHereBb = 1,
- VeryLongVariantNameHereCcc = 2,
-}
+use foo::{
+ aaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbb, cccccccccccccccccc, dddddddddddddddddd,
+ eeeeeeeeeeeeeeeeee, ffffffffffffffffff,
+};
```
+#### `"Horizontal"`:
-## `fn_single_line`
+**Note**: This option forces all imports onto one line and may exceed `max_width`.
-Put single-expression functions on a single line
+```rust
+use foo::{xxx, yyy, zzz};
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+use foo::{aaa, bbb, ccc, ddd, eee, fff};
+```
-#### `false` (default):
+#### `"HorizontalVertical"`:
```rust
-fn lorem() -> usize {
- 42
-}
+use foo::{xxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyy, zzzzzzzzzzzzzzzzzz};
-fn lorem() -> usize {
- let ipsum = 42;
- ipsum
-}
+use foo::{
+ aaaaaaaaaaaaaaaaaa,
+ bbbbbbbbbbbbbbbbbb,
+ cccccccccccccccccc,
+ dddddddddddddddddd,
+ eeeeeeeeeeeeeeeeee,
+ ffffffffffffffffff,
+};
```
-#### `true`:
+#### `"Vertical"`:
```rust
-fn lorem() -> usize { 42 }
+use foo::{
+ xxx,
+ yyy,
+ zzz,
+};
-fn lorem() -> usize {
- let ipsum = 42;
- ipsum
-}
+use foo::{
+ aaa,
+ bbb,
+ ccc,
+ ddd,
+ eee,
+ fff,
+};
```
-See also [`control_brace_style`](#control_brace_style).
-
+## `indent_style`
-## `where_single_line`
+Indent on expressions or items.
-Forces the `where` clause to be laid out 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
-impl<T> Lorem for T
-where
- Option<T>: Ipsum,
-{
- // body
+fn main() {
+ let lorem = vec![
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit",
+ ];
}
```
-#### `true`:
+#### `"Visual"`:
```rust
-impl<T> Lorem for T
-where Option<T>: Ipsum
-{
- // body
+fn main() {
+ let lorem = vec!["ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit"];
}
```
-See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
-
-
-## `force_explicit_abi`
-
-Always print the abi for extern items
+### Control flow
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
+#### `"Block"` (default):
-**Note:** Non-"C" ABIs are always printed. If `false` then "C" is removed.
+```rust
+fn main() {
+ if lorem_ipsum
+ && dolor_sit
+ && amet_consectetur
+ && lorem_sit
+ && dolor_consectetur
+ && amet_ipsum
+ && lorem_consectetur
+ {
+ // ...
+ }
+}
+```
-#### `true` (default):
+#### `"Visual"`:
```rust
-extern "C" {
- pub static lorem: c_int;
+fn main() {
+ if lorem_ipsum
+ && dolor_sit
+ && amet_consectetur
+ && lorem_sit
+ && dolor_consectetur
+ && amet_ipsum
+ && lorem_consectetur
+ {
+ // ...
+ }
}
```
-#### `false`:
-
-```rust
-extern {
- pub static lorem: c_int;
-}
-```
+See also: [`control_brace_style`](#control_brace_style).
-## `format_strings`
+### Function arguments
-Format string literals where necessary
+#### `"Block"` (default):
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+```rust
+fn lorem() {}
-#### `false` (default):
+fn lorem(ipsum: usize) {}
-```rust
-fn main() {
- let lorem =
- "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet consectetur adipiscing";
+fn lorem(
+ ipsum: usize,
+ dolor: usize,
+ sit: usize,
+ amet: usize,
+ consectetur: usize,
+ adipiscing: usize,
+ elit: usize,
+) {
+ // body
}
```
-#### `true`:
+#### `"Visual"`:
```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).
+fn lorem() {}
-## `format_macro_matchers`
+fn lorem(ipsum: usize) {}
-Format the metavariable matching patterns in macros.
+fn lorem(ipsum: usize,
+ dolor: usize,
+ sit: usize,
+ amet: usize,
+ consectetur: usize,
+ adipiscing: usize,
+ elit: usize) {
+ // body
+}
+```
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+### Function calls
-#### `false` (default):
+#### `"Block"` (default):
```rust
-macro_rules! foo {
- ($a: ident : $b: ty) => {
- $a(42): $b;
- };
- ($a: ident $b: ident $c: ident) => {
- $a = $b + $c;
- };
+fn main() {
+ lorem(
+ "lorem",
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit",
+ );
}
```
-#### `true`:
+#### `"Visual"`:
```rust
-macro_rules! foo {
- ($a:ident : $b:ty) => {
- $a(42): $b;
- };
- ($a:ident $b:ident $c:ident) => {
- $a = $b + $c;
- };
+fn main() {
+ lorem("lorem",
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit");
}
```
-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
+### Generics
-#### `true` (default):
+#### `"Block"` (default):
```rust
-macro_rules! foo {
- ($a: ident : $b: ty) => {
- $a(42): $b;
- };
- ($a: ident $b: ident $c: ident) => {
- $a = $b + $c;
- };
+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
-macro_rules! foo {
- ($a: ident : $b: ty) => { $a(42): $b; };
- ($a: ident $b: ident $c: ident) => { $a=$b+$c; };
+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
}
```
-See also [`format_macro_matchers`](#format_macro_matchers).
-
-
-## `hard_tabs`
-
-Use tab characters for indentation, spaces for alignment
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
+#### Struct
-#### `false` (default):
+#### `"Block"` (default):
```rust
-fn lorem() -> usize {
- 42 // spaces before 42
+fn main() {
+ let lorem = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
}
```
-#### `true`:
+#### `"Visual"`:
```rust
-fn lorem() -> usize {
- 42 // tabs before 42
+fn main() {
+ let lorem = Lorem { ipsum: dolor,
+ sit: amet };
}
```
-See also: [`tab_spaces`](#tab_spaces).
-
-
-## `imports_indent`
-
-Indent style of imports
+See also: [`struct_lit_single_line`](#struct_lit_single_line), [`indent_style`](#indent_style).
-- **Default Value**: `"Block"`
-- **Possible values**: `"Block"`, `"Visual"`
-- **Stable**: No
+### Where predicates
#### `"Block"` (default):
```rust
-use foo::{
- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy,
- zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
-};
+fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
+where
+ Ipsum: Eq,
+ Dolor: Eq,
+ Sit: Eq,
+ Amet: Eq,
+{
+ // body
+}
```
#### `"Visual"`:
```rust
-use foo::{xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy,
- zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz};
+fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
+ where Ipsum: Eq,
+ Dolor: Eq,
+ Sit: Eq,
+ Amet: Eq
+{
+ // body
+}
```
-See also: [`imports_layout`](#imports_layout).
-
-## `imports_layout`
+## `inline_attribute_width`
-Item layout inside a imports block
+Write an item and its attribute on the same line if their combined width is below a threshold
-- **Default value**: "Mixed"
-- **Possible values**: "Horizontal", "HorizontalVertical", "Mixed", "Vertical"
-- **Stable**: No
+- **Default value**: 0
+- **Possible values**: any positive integer
+- **Stable**: No (tracking issue: #3343)
-#### `"Mixed"` (default):
+### Example
+#### `0` (default):
```rust
-use foo::{xxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyy, zzzzzzzzzzzzzzzzzz};
-
-use foo::{
- aaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbb, cccccccccccccccccc, dddddddddddddddddd,
- eeeeeeeeeeeeeeeeee, ffffffffffffffffff,
-};
+#[cfg(feature = "alloc")]
+use core::slice;
```
-#### `"Horizontal"`:
-
-**Note**: This option forces all imports onto one line and may exceed `max_width`.
-
+#### `50`:
```rust
-use foo::{xxx, yyy, zzz};
-
-use foo::{aaa, bbb, ccc, ddd, eee, fff};
+#[cfg(feature = "alloc")] use core::slice;
```
-#### `"HorizontalVertical"`:
-
-```rust
-use foo::{xxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyy, zzzzzzzzzzzzzzzzzz};
+## `license_template_path`
-use foo::{
- aaaaaaaaaaaaaaaaaa,
- bbbbbbbbbbbbbbbbbb,
- cccccccccccccccccc,
- dddddddddddddddddd,
- eeeeeeeeeeeeeeeeee,
- ffffffffffffffffff,
-};
-```
+Check whether beginnings of files match a license template.
-#### `"Vertical"`:
+- **Default value**: `""`
+- **Possible values**: path to a license template file
+- **Stable**: No (tracking issue: #3352)
-```rust
-use foo::{
- xxx,
- yyy,
- zzz,
-};
+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::{
- aaa,
- bbb,
- ccc,
- ddd,
- eee,
- fff,
-};
+```
+// Copyright {\d+} The Rust Project Developers.
```
-## `merge_imports`
+`\{`, `\}` and `\\` match literal braces / backslashes.
-Merge multiple imports into a single nested import.
+## `match_arm_blocks`
-- **Default value**: `false`
+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**: No (tracking issue: #3373)
-#### `false` (default):
+#### `true` (default):
```rust
-use foo::{a, c, d};
-use foo::{b, g};
-use foo::{e, f};
+fn main() {
+ match lorem {
+ true => {
+ foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x)
+ }
+ false => println!("{}", sit),
+ }
+}
```
-#### `true`:
+#### `false`:
```rust
-use foo::{a, b, c, d, e, f, g};
+fn main() {
+ match lorem {
+ true =>
+ foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x),
+ false => println!("{}", sit),
+ }
+}
```
+See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
## `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 => |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 => {
- |ipsum| {
- println!("Hello World");
- }
- }
- Some(dolor) => foo(),
- }
-}
+use foo::{a, b, c, d, e, f, g};
```
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
-
-#### `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 {}
-```
-
-## `remove_nested_parens`
-
-Remove nested parens.
-
-- **Default value**: `true`,
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
-
-
-#### `true` (default):
-```rust
-fn main() {
- (foo());
-}
-```
-
-#### `false`:
-```rust
-fn main() {
- ((((foo()))));
-}
-```
-
-
-## `reorder_imports`
-
-Reorder import and extern crate statements alphabetically in groups (a group is
-separated by a newline).
-
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
-
-#### `true` (default):
-
-```rust
-use dolor;
-use ipsum;
-use lorem;
-use sit;
-```
-
-#### `false`:
-
-```rust
-use lorem;
-use ipsum;
-use dolor;
-use sit;
-```
-
-
-## `reorder_modules`
-
-Reorder `mod` declarations alphabetically in group.
-
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
-
-#### `true` (default)
-
-```rust
-mod a;
-mod b;
-
-mod dolor;
-mod ipsum;
-mod lorem;
-mod sit;
-```
-
-#### `false`
-
-```rust
-mod b;
-mod a;
-
-mod lorem;
-mod ipsum;
-mod dolor;
-mod sit;
-```
-
-**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
- }
-
- type Item = i32;
-}
-```
-
-#### `true`
-
-```rust
-struct Dummy;
-
-impl Iterator for Dummy {
- type Item = i32;
-
- fn next(&mut self) -> Option<Self::Item> {
- None
- }
-}
-```
+ending style.
-## `report_todo`
+#### `Native`
-Report `TODO` items in comments.
+Line endings will be converted to `\r\n` on Windows and `\n` on all
+other platforms.
-- **Default value**: `"Never"`
-- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
-- **Stable**: No
+#### `Unix`
-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.
+Line endings will be converted to `\n`.
-See also [`report_fixme`](#report_fixme).
+#### `Windows`
-## `report_fixme`
+Line endings will be converted to `\r\n`.
-Report `FIXME` items in comments.
+## `normalize_comments`
-- **Default value**: `"Never"`
-- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
-- **Stable**: No
+Convert /* */ comments to // comments where possible
-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.
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3350)
-See also [`report_todo`](#report_todo).
+#### `false` (default):
+
+```rust
+// Lorem ipsum:
+fn dolor() -> usize {}
+/* sit amet: */
+fn adipiscing() -> usize {}
+```
-## `skip_children`
+#### `true`:
-Don't reformat out of line modules
+```rust
+// Lorem ipsum:
+fn dolor() -> usize {}
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+// sit amet:
+fn adipiscing() -> usize {}
+```
-## `space_after_colon`
+## `normalize_doc_attributes`
-Leave a space after the colon.
+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 lorem<T: Eq>(t: T) {
- let lorem: Dolor = Lorem {
- ipsum: dolor,
- sit: amet,
- };
-}
+#![doc = "Example documentation"]
+
+#[doc = "Example item documentation"]
+pub enum Foo {}
```
-#### `false`:
+#### `true`:
```rust
-fn lorem<T:Eq>(t:T) {
- let lorem:Dolor = Lorem {
- ipsum:dolor,
- sit:amet,
- };
-}
-```
+//! Example documentation
-See also: [`space_before_colon`](#space_before_colon).
+/// Example item documentation
+pub enum Foo {}
+```
-## `space_before_colon`
+## `overflow_delimited_expr`
-Leave a space before the colon.
+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
-fn lorem<T: Eq>(t: T) {
- let lorem: Dolor = Lorem {
- ipsum: dolor,
- sit: amet,
- };
+fn example() {
+ foo(ctx, |param| {
+ action();
+ foo(param)
+ });
+
+ 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
-fn lorem<T : Eq>(t : T) {
- let lorem : Dolor = Lorem {
- ipsum : dolor,
- sit : amet,
- };
+fn example() {
+ foo(ctx, |param| {
+ action();
+ foo(param)
+ });
+
+ 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,
+ ]);
}
```
-See also: [`space_after_colon`](#space_after_colon).
-
-## `struct_field_align_threshold`
+## `remove_nested_parens`
-The maximum diff of width between struct fields to be aligned with each other.
+Remove nested parens.
-- **Default value** : 0
-- **Possible values**: any positive integer
-- **Stable**: No
+- **Default value**: `true`,
+- **Possible values**: `true`, `false`
+- **Stable**: Yes
-#### `0` (default):
+#### `true` (default):
```rust
-struct Foo {
- x: u32,
- yy: u32,
- zzz: u32,
+fn main() {
+ (foo());
}
```
-#### `20`:
-
+#### `false`:
```rust
-struct Foo {
- x: u32,
- yy: u32,
- zzz: u32,
+fn main() {
+ ((((foo()))));
}
```
-## `spaces_around_ranges`
-Put spaces around the .., ..=, and ... range operators
+## `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
+- **Stable**: No (tracking issue: #3363)
-#### `false` (default):
+#### `false` (default)
```rust
-fn main() {
- let lorem = 0..10;
- let ipsum = 0..=10;
-
- match lorem {
- 1..5 => foo(),
- _ => bar,
- }
+struct Dummy;
- match lorem {
- 1..=5 => foo(),
- _ => bar,
+impl Iterator for Dummy {
+ fn next(&mut self) -> Option<Self::Item> {
+ None
}
- match lorem {
- 1...5 => foo(),
- _ => bar,
- }
+ type Item = i32;
}
```
-#### `true`:
+#### `true`
```rust
-fn main() {
- let lorem = 0 .. 10;
- let ipsum = 0 ..= 10;
-
- match lorem {
- 1 .. 5 => foo(),
- _ => bar,
- }
+struct Dummy;
- match lorem {
- 1 ..= 5 => foo(),
- _ => bar,
- }
+impl Iterator for Dummy {
+ type Item = i32;
- match lorem {
- 1 ... 5 => foo(),
- _ => bar,
+ fn next(&mut self) -> Option<Self::Item> {
+ None
}
}
```
-## `struct_lit_single_line`
+## `reorder_imports`
-Put small struct literals on a single line
+Reorder import and extern crate statements alphabetically in groups (a group is
+separated by a newline).
- **Default value**: `true`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: Yes
#### `true` (default):
```rust
-fn main() {
- let lorem = Lorem { foo: bar, baz: ofo };
-}
+use dolor;
+use ipsum;
+use lorem;
+use sit;
```
#### `false`:
```rust
-fn main() {
- let lorem = Lorem {
- foo: bar,
- baz: ofo,
- };
-}
+use lorem;
+use ipsum;
+use dolor;
+use sit;
```
-See also: [`indent_style`](#indent_style).
-
-## `tab_spaces`
+## `reorder_modules`
-Number of spaces per tab
+Reorder `mod` declarations alphabetically in group.
-- **Default value**: `4`
-- **Possible values**: any positive integer
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
- **Stable**: Yes
-#### `4` (default):
+#### `true` (default)
```rust
-fn lorem() {
- let ipsum = dolor();
- let sit = vec![
- "amet consectetur adipiscing elit amet",
- "consectetur adipiscing elit amet consectetur.",
- ];
-}
+mod a;
+mod b;
+
+mod dolor;
+mod ipsum;
+mod lorem;
+mod sit;
```
-#### `2`:
+#### `false`
```rust
-fn lorem() {
- let ipsum = dolor();
- let sit = vec![
- "amet consectetur adipiscing elit amet",
- "consectetur adipiscing elit amet consectetur.",
- ];
-}
+mod b;
+mod a;
+
+mod lorem;
+mod ipsum;
+mod dolor;
+mod sit;
```
-See also: [`hard_tabs`](#hard_tabs).
+**Note** `mod` with `#[macro_export]` will not be reordered since that could change the semantics
+of the original source code.
+## `report_fixme`
-## `trailing_comma`
+Report `FIXME` items in comments.
-How to handle trailing commas for lists
+- **Default value**: `"Never"`
+- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
+- **Stable**: No (tracking issue: #3394)
-- **Default value**: `"Vertical"`
-- **Possible values**: `"Always"`, `"Never"`, `"Vertical"`
-- **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.
-#### `"Vertical"` (default):
+See also [`report_todo`](#report_todo).
-```rust
-fn main() {
- let Lorem { ipsum, dolor, sit } = amet;
- let Lorem {
- ipsum,
- dolor,
- sit,
- amet,
- consectetur,
- adipiscing,
- } = elit;
-}
-```
-#### `"Always"`:
+## `report_todo`
-```rust
-fn main() {
- let Lorem { ipsum, dolor, sit, } = amet;
- let Lorem {
- ipsum,
- dolor,
- sit,
- amet,
- consectetur,
- adipiscing,
- } = elit;
-}
-```
+Report `TODO` items in comments.
-#### `"Never"`:
+- **Default value**: `"Never"`
+- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
+- **Stable**: No (tracking issue: #3393)
-```rust
-fn main() {
- let Lorem { ipsum, dolor, sit } = amet;
- let Lorem {
- ipsum,
- dolor,
- sit,
- amet,
- consectetur,
- adipiscing
- } = elit;
-}
-```
+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: [`match_block_trailing_comma`](#match_block_trailing_comma).
+See also [`report_fixme`](#report_fixme).
-## `trailing_semicolon`
+## `required_version`
-Add trailing semicolon after break, continue and return
+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**: `true`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Default value**: `CARGO_PKG_VERSION`
+- **Possible values**: any published version (e.g. `"0.3.8"`)
+- **Stable**: No (tracking issue: #3386)
-#### `true` (default):
-```rust
-fn foo() -> usize {
- return 0;
-}
-```
+## `skip_children`
-#### `false`:
-```rust
-fn foo() -> usize {
- return 0
-}
-```
+Don't reformat out of line modules
-## `type_punctuation_density`
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3389)
-Determines if `+` or `=` are wrapped in spaces in the punctuation of types
+## `space_after_colon`
-- **Default value**: `"Wide"`
-- **Possible values**: `"Compressed"`, `"Wide"`
-- **Stable**: No
+Leave a space after the colon.
-#### `"Wide"` (default):
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3366)
+
+#### `true` (default):
```rust
-fn lorem<Ipsum: Dolor + Sit = Amet>() {
- // body
+fn lorem<T: Eq>(t: T) {
+ let lorem: Dolor = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
}
```
-#### `"Compressed"`:
+#### `false`:
```rust
-fn lorem<Ipsum: Dolor+Sit=Amet>() {
- // body
+fn lorem<T:Eq>(t:T) {
+ let lorem:Dolor = Lorem {
+ ipsum:dolor,
+ sit:amet,
+ };
}
```
-## `use_field_init_shorthand`
+See also: [`space_before_colon`](#space_before_colon).
-Use field initialize shorthand if possible.
+## `space_before_colon`
+
+Leave a space before the colon.
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: Yes
+- **Stable**: No (tracking issue: #3365)
#### `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 };
+fn lorem<T: Eq>(t: T) {
+ let lorem: Dolor = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
}
```
#### `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 };
+fn lorem<T : Eq>(t : T) {
+ let lorem : Dolor = Lorem {
+ ipsum : dolor,
+ sit : amet,
+ };
}
```
-## `use_try_shorthand`
+See also: [`space_after_colon`](#space_after_colon).
-Replace uses of the try! macro by the ? shorthand
+## `spaces_around_ranges`
+
+Put spaces around the .., ..=, and ... range operators
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: Yes
+- **Stable**: No (tracking issue: #3367)
#### `false` (default):
```rust
fn main() {
- let lorem = try!(ipsum.map(|dolor| dolor.sit()));
+ let lorem = 0..10;
+ let ipsum = 0..=10;
+
+ match lorem {
+ 1..5 => foo(),
+ _ => bar,
+ }
+
+ match lorem {
+ 1..=5 => foo(),
+ _ => bar,
+ }
+
+ match lorem {
+ 1...5 => foo(),
+ _ => bar,
+ }
}
```
```rust
fn main() {
- let lorem = ipsum.map(|dolor| dolor.sit())?;
-}
-```
-
-## `format_doc_comments`
-
-Format doc comments.
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
-
-#### `false` (default):
+ let lorem = 0 .. 10;
+ let ipsum = 0 ..= 10;
-```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
-}
-```
+ match lorem {
+ 1 .. 5 => foo(),
+ _ => bar,
+ }
-#### `true`
+ match lorem {
+ 1 ..= 5 => foo(),
+ _ => bar,
+ }
-```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
+ match lorem {
+ 1 ... 5 => foo(),
+ _ => bar,
+ }
}
```
-## `wrap_comments`
+## `struct_field_align_threshold`
-Break comments to fit on the line
+The maximum diff of width between struct fields to be aligned with each other.
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Default value** : 0
+- **Possible values**: any non-negative integer
+- **Stable**: No (tracking issue: #3371)
-#### `false` (default):
+#### `0` (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.
+struct Foo {
+ x: u32,
+ yy: u32,
+ zzz: u32,
+}
```
-#### `true`:
+#### `20`:
```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.
+struct Foo {
+ x: u32,
+ yy: u32,
+ zzz: u32,
+}
```
-## `match_arm_blocks`
+## `struct_lit_single_line`
-Wrap the body of arms in blocks when it does not fit on the same line with the pattern of arms
+Put small struct literals on a single line
- **Default value**: `true`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3357)
#### `true` (default):
```rust
fn main() {
- match lorem {
- true => {
- foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x)
- }
- false => println!("{}", sit),
- }
+ let lorem = Lorem { foo: bar, baz: ofo };
}
```
```rust
fn main() {
- match lorem {
- true =>
- foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x),
- false => println!("{}", sit),
- }
+ let lorem = Lorem {
+ foo: bar,
+ baz: ofo,
+ };
}
```
-See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
-
-## `overflow_delimited_expr`
-
-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.
+See also: [`indent_style`](#indent_style).
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
-#### `false` (default):
+## `tab_spaces`
-```rust
-fn example() {
- foo(ctx, |param| {
- action();
- foo(param)
- });
+Number of spaces per tab
- foo(
- ctx,
- Bar {
- x: value,
- y: value2,
- },
- );
+- **Default value**: `4`
+- **Possible values**: any positive integer
+- **Stable**: Yes
- foo(
- ctx,
- &[
- MAROON_TOMATOES,
- PURPLE_POTATOES,
- ORGANE_ORANGES,
- GREEN_PEARS,
- RED_APPLES,
- ],
- );
+#### `4` (default):
- foo(
- ctx,
- vec![
- MAROON_TOMATOES,
- PURPLE_POTATOES,
- ORGANE_ORANGES,
- GREEN_PEARS,
- RED_APPLES,
- ],
- );
+```rust
+fn lorem() {
+ let ipsum = dolor();
+ let sit = vec![
+ "amet consectetur adipiscing elit amet",
+ "consectetur adipiscing elit amet consectetur.",
+ ];
}
```
-#### `true`:
+#### `2`:
```rust
-fn example() {
- foo(ctx, |param| {
- action();
- foo(param)
- });
-
- 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,
- ]);
+fn lorem() {
+ let ipsum = dolor();
+ let sit = vec![
+ "amet consectetur adipiscing elit amet",
+ "consectetur adipiscing elit amet consectetur.",
+ ];
}
```
-## `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**: *unsigned integer*
-- **Stable**: No
-
-### Example
-Original Code:
-
-```rust
-#![rustfmt::skip]
+See also: [`hard_tabs`](#hard_tabs).
-fn foo() {
- println!("a");
-}
+## `trailing_comma`
+How to handle trailing commas for lists
-fn bar() {
- println!("b");
+- **Default value**: `"Vertical"`
+- **Possible values**: `"Always"`, `"Never"`, `"Vertical"`
+- **Stable**: No (tracking issue: #3379)
+#### `"Vertical"` (default):
- println!("c");
+```rust
+fn main() {
+ let Lorem { ipsum, dolor, sit } = amet;
+ let Lorem {
+ ipsum,
+ dolor,
+ sit,
+ amet,
+ consectetur,
+ adipiscing,
+ } = elit;
}
```
-#### `1` (default):
+#### `"Always"`:
+
```rust
-fn foo() {
- println!("a");
+fn main() {
+ let Lorem { ipsum, dolor, sit, } = amet;
+ let Lorem {
+ ipsum,
+ dolor,
+ sit,
+ amet,
+ consectetur,
+ adipiscing,
+ } = elit;
}
+```
-fn bar() {
- println!("b");
+#### `"Never"`:
- println!("c");
+```rust
+fn main() {
+ let Lorem { ipsum, dolor, sit } = amet;
+ let Lorem {
+ ipsum,
+ dolor,
+ sit,
+ amet,
+ consectetur,
+ adipiscing
+ } = elit;
}
```
-#### `2`:
-```rust
-fn foo() {
- println!("a");
-}
+See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
+
+## `trailing_semicolon`
+Add trailing semicolon after break, continue and return
-fn bar() {
- println!("b");
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: #3378)
+#### `true` (default):
+```rust
+fn foo() -> usize {
+ return 0;
+}
+```
- println!("c");
+#### `false`:
+```rust
+fn foo() -> usize {
+ return 0
}
```
-See also: [`blank_lines_lower_bound`](#blank_lines_lower_bound)
-
-## `blank_lines_lower_bound`
+## `type_punctuation_density`
-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.
+Determines if `+` or `=` are wrapped in spaces in the punctuation of types
-- **Default value**: `0`
-- **Possible values**: *unsigned integer*
-- **Stable**: No
+- **Default value**: `"Wide"`
+- **Possible values**: `"Compressed"`, `"Wide"`
+- **Stable**: No (tracking issue: #3364)
-### Example
-Original Code (rustfmt will not change it with the default value of `0`):
+#### `"Wide"` (default):
```rust
-#![rustfmt::skip]
-
-fn foo() {
- println!("a");
-}
-fn bar() {
- println!("b");
- println!("c");
+fn lorem<Ipsum: Dolor + Sit = Amet>() {
+ // body
}
```
-#### `1`
-```rust
-fn foo() {
-
- println!("a");
-}
-
-fn bar() {
-
- println!("b");
+#### `"Compressed"`:
- println!("c");
+```rust
+fn lorem<Ipsum: Dolor+Sit=Amet>() {
+ // body
}
```
+## `unstable_features`
-## `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.
+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`
+## `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`
+#### `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`
+#### `true`:
-Enable unstable features on stable 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`
+## `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",
+ );
-## `ignore`
+ let lorem = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
+ let lorem = Lorem { ipsum: dolor };
-Skip formatting the specified files and directories.
+ let lorem = if ipsum { dolor } else { sit };
+}
+```
-- **Default value**: format every files
-- **Possible values**: See an example below
-- **Stable**: No
+#### `Off`:
-### Example
+```rust
+enum Lorem {
+ Ipsum,
+ Dolor(bool),
+ Sit {
+ amet: Consectetur,
+ adipiscing: Elit,
+ },
+}
-If you want to ignore specific files, put the following to your config file:
+fn main() {
+ lorem("lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing");
-```toml
-ignore = [
- "src/types.rs",
- "src/foo/bar.rs",
-]
+ let lorem = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
+
+ 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):
-If you want to format code that requires edition 2018, add the following to your config file:
+```rust
+fn main() {
+ let lorem = try!(ipsum.map(|dolor| dolor.sit()));
+}
+```
-```toml
-edition = "2018"
+#### `true`:
+
+```rust
+fn main() {
+ let lorem = ipsum.map(|dolor| dolor.sit())?;
+}
```
## `version`
- **Default value**: `One`
- **Possible values**: `One`, `Two`
-- **Stable**: No
+- **Stable**: No (tracking issue: #3383)
### Example
version = "Two"
```
-## `normalize_doc_attributes`
+## `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.
```
+# Internal Options
+
## `emit_mode`
Internal option
## `make_backup`
Internal option, use `--backup`
+
+## `print_misformatted_file_names`
+
+Internal option, use `-l` or `--files-with-diff`
projects / rust.git / blobdiff