# 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:
+## `array_width`
-## `indent_style`
+Maximum width of an array literal before falling back to vertical formatting.
-Indent on expressions or items.
+- **Default value**: `60`
+- **Possible values**: any positive integer that is less than or equal to the value specified for [`max_width`](#max_width)
+- **Stable**: Yes
-- **Default value**: `"Block"`
-- **Possible values**: `"Block"`, `"Visual"`
-- **Stable**: No
+By default this option is set as a percentage of [`max_width`](#max_width) provided by [`use_small_heuristics`](#use_small_heuristics), but a value set directly for `array_width` will take precedence.
-### Array
+See also [`max_width`](#max_width) and [`use_small_heuristics`](#use_small_heuristics)
-#### `"Block"` (default):
+## `attr_fn_like_width`
+
+Maximum width of the args of a function-like attributes before falling back to vertical formatting.
+
+- **Default value**: `70`
+- **Possible values**: any positive integer that is less than or equal to the value specified for [`max_width`](#max_width)
+- **Stable**: Yes
+
+By default this option is set as a percentage of [`max_width`](#max_width) provided by [`use_small_heuristics`](#use_small_heuristics), but a value set directly for `attr_fn_like_width` will take precedence.
+
+See also [`max_width`](#max_width) and [`use_small_heuristics`](#use_small_heuristics)
+
+## `binop_separator`
+
+Where to put a binary operator when a binary expression goes multiline.
+
+- **Default value**: `"Front"`
+- **Possible values**: `"Front"`, `"Back"`
+- **Stable**: No (tracking issue: [#3368](https://github.com/rust-lang/rustfmt/issues/3368))
+
+#### `"Front"` (default):
```rust
fn main() {
- let lorem = vec![
- "ipsum",
- "dolor",
- "sit",
- "amet",
- "consectetur",
- "adipiscing",
- "elit",
- ];
+ let or = foofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoo
+ || barbarbarbarbarbarbarbarbarbarbarbarbarbarbarbar;
+
+ let sum = 123456789012345678901234567890
+ + 123456789012345678901234567890
+ + 123456789012345678901234567890;
+
+ let range = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+ ..bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;
}
```
-#### `"Visual"`:
+#### `"Back"`:
```rust
fn main() {
- let lorem = vec!["ipsum",
- "dolor",
- "sit",
- "amet",
- "consectetur",
- "adipiscing",
- "elit"];
+ let or = foofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoo ||
+ barbarbarbarbarbarbarbarbarbarbarbarbarbarbarbar;
+
+ let sum = 123456789012345678901234567890 +
+ 123456789012345678901234567890 +
+ 123456789012345678901234567890;
+
+ let range = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa..
+ bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;
}
```
-### Control flow
+## `blank_lines_lower_bound`
-#### `"Block"` (default):
+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.
+
+- **Default value**: `0`
+- **Possible values**: *unsigned integer*
+- **Stable**: No (tracking issue: [#3382](https://github.com/rust-lang/rustfmt/issues/3382))
+
+### Example
+Original Code (rustfmt will not change it with the default value of `0`):
```rust
-fn main() {
- if lorem_ipsum
- && dolor_sit
- && amet_consectetur
- && lorem_sit
- && dolor_consectetur
- && amet_ipsum
- && lorem_consectetur
- {
- // ...
- }
+#![rustfmt::skip]
+
+fn foo() {
+ println!("a");
+}
+fn bar() {
+ println!("b");
+ println!("c");
+}
+```
+
+#### `1`
+```rust
+fn foo() {
+
+ println!("a");
+}
+
+fn bar() {
+
+ println!("b");
+
+ 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](https://github.com/rust-lang/rustfmt/issues/3381))
+
+### Example
+Original Code:
```rust
-fn main() {
- if lorem_ipsum
- && dolor_sit
- && amet_consectetur
- && lorem_sit
- && dolor_consectetur
- && amet_ipsum
- && lorem_consectetur
- {
- // ...
- }
+#![rustfmt::skip]
+
+fn foo() {
+ println!("a");
+}
+
+
+
+fn bar() {
+ println!("b");
+
+
+ println!("c");
}
```
-See also: [`control_brace_style`](#control_brace_style).
+#### `1` (default):
+```rust
+fn foo() {
+ println!("a");
+}
-### Function arguments
+fn bar() {
+ println!("b");
-#### `"Block"` (default):
+ println!("c");
+}
+```
+#### `2`:
```rust
-fn lorem() {}
+fn foo() {
+ println!("a");
+}
-fn lorem(ipsum: usize) {}
-fn lorem(
- ipsum: usize,
- dolor: usize,
- sit: usize,
- amet: usize,
- consectetur: usize,
- adipiscing: usize,
- elit: usize,
-) {
+fn bar() {
+ println!("b");
+
+
+ println!("c");
+}
+```
+
+See also: [`blank_lines_lower_bound`](#blank_lines_lower_bound)
+
+## `brace_style`
+
+Brace style for items
+
+- **Default value**: `"SameLineWhere"`
+- **Possible values**: `"AlwaysNextLine"`, `"PreferSameLine"`, `"SameLineWhere"`
+- **Stable**: No (tracking issue: [#3376](https://github.com/rust-lang/rustfmt/issues/3376))
+
+### Functions
+
+#### `"SameLineWhere"` (default):
+
+```rust
+fn lorem() {
+ // body
+}
+
+fn lorem(ipsum: usize) {
+ // body
+}
+
+fn lorem<T>(ipsum: T)
+where
+ T: Add + Sub + Mul + Div,
+{
// body
}
```
-#### `"Visual"`:
+#### `"AlwaysNextLine"`:
```rust
-fn lorem() {}
+fn lorem()
+{
+ // body
+}
-fn lorem(ipsum: usize) {}
+fn lorem(ipsum: usize)
+{
+ // body
+}
-fn lorem(ipsum: usize,
- dolor: usize,
- sit: usize,
- amet: usize,
- consectetur: usize,
- adipiscing: usize,
- elit: usize) {
+fn lorem<T>(ipsum: T)
+where
+ T: Add + Sub + Mul + Div,
+{
// body
}
```
-### Function calls
+#### `"PreferSameLine"`:
-#### `"Block"` (default):
+```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
-fn main() {
- lorem(
- "lorem",
- "ipsum",
- "dolor",
- "sit",
- "amet",
- "consectetur",
- "adipiscing",
- "elit",
- );
+struct Lorem {
+ ipsum: bool,
+}
+
+struct Dolor<T>
+where
+ T: Eq,
+{
+ sit: T,
}
```
-#### `"Visual"`:
+#### `"AlwaysNextLine"`:
```rust
-fn main() {
- lorem("lorem",
- "ipsum",
- "dolor",
- "sit",
- "amet",
- "consectetur",
- "adipiscing",
- "elit");
+struct Lorem
+{
+ ipsum: bool,
+}
+
+struct Dolor<T>
+where
+ T: Eq,
+{
+ sit: T,
}
```
-### Generics
+#### `"PreferSameLine"`:
-#### `"Block"` (default):
+```rust
+struct Lorem {
+ ipsum: bool,
+}
+
+struct Dolor<T>
+where
+ T: Eq, {
+ sit: T,
+}
+```
+
+## `chain_width`
+
+Maximum width of a chain to fit on one line.
+
+- **Default value**: `60`
+- **Possible values**: any positive integer that is less than or equal to the value specified for [`max_width`](#max_width)
+- **Stable**: Yes
+
+By default this option is set as a percentage of [`max_width`](#max_width) provided by [`use_small_heuristics`](#use_small_heuristics), but a value set directly for `chain_width` will take precedence.
+
+See also [`max_width`](#max_width) and [`use_small_heuristics`](#use_small_heuristics)
+
+## `color`
+
+Whether to use colored output or not.
+
+- **Default value**: `"Auto"`
+- **Possible values**: "Auto", "Always", "Never"
+- **Stable**: No (tracking issue: [#3385](https://github.com/rust-lang/rustfmt/issues/3385))
+
+## `combine_control_expr`
+
+Combine control expressions with function calls.
+
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: [#3369](https://github.com/rust-lang/rustfmt/issues/3369))
+
+#### `true` (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 example() {
+ // If
+ foo!(if x {
+ foo();
+ } else {
+ bar();
+ });
+
+ // IfLet
+ foo!(if let Some(..) = x {
+ foo();
+ } else {
+ bar();
+ });
+
+ // While
+ foo!(while x {
+ foo();
+ bar();
+ });
+
+ // WhileLet
+ foo!(while let Some(..) = x {
+ foo();
+ bar();
+ });
+
+ // ForLoop
+ foo!(for x in y {
+ foo();
+ bar();
+ });
+
+ // Loop
+ foo!(loop {
+ foo();
+ bar();
+ });
}
```
-#### `"Visual"`:
+#### `false`:
```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 example() {
+ // If
+ foo!(
+ if x {
+ foo();
+ } else {
+ bar();
+ }
+ );
+
+ // IfLet
+ foo!(
+ if let Some(..) = x {
+ foo();
+ } else {
+ bar();
+ }
+ );
+
+ // While
+ foo!(
+ while x {
+ foo();
+ bar();
+ }
+ );
+
+ // WhileLet
+ foo!(
+ while let Some(..) = x {
+ foo();
+ bar();
+ }
+ );
+
+ // ForLoop
+ foo!(
+ for x in y {
+ foo();
+ bar();
+ }
+ );
+
+ // Loop
+ foo!(
+ loop {
+ foo();
+ bar();
+ }
+ );
}
```
-#### Struct
+## `comment_width`
+
+Maximum length of comments. No effect unless`wrap_comments = true`.
+
+- **Default value**: `80`
+- **Possible values**: any positive integer
+- **Stable**: No (tracking issue: [#3349](https://github.com/rust-lang/rustfmt/issues/3349))
+
+**Note:** A value of `0` results in [`wrap_comments`](#wrap_comments) being applied regardless of a line's width.
+
+#### `80` (default; comments shorter than `comment_width`):
+```rust
+// Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+```
+
+#### `60` (comments longer than `comment_width`):
+```rust
+// Lorem ipsum dolor sit amet,
+// consectetur adipiscing elit.
+```
+
+See also [`wrap_comments`](#wrap_comments).
+
+## `condense_wildcard_suffixes`
+
+Replace strings of _ wildcards by a single .. in tuple patterns
-#### `"Block"` (default):
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: [#3384](https://github.com/rust-lang/rustfmt/issues/3384))
+
+#### `false` (default):
```rust
fn main() {
- let lorem = Lorem {
- ipsum: dolor,
- sit: amet,
- };
+ let (lorem, ipsum, _, _) = (1, 2, 3, 4);
+ let (lorem, ipsum, ..) = (1, 2, 3, 4);
}
```
-#### `"Visual"`:
+#### `true`:
```rust
fn main() {
- let lorem = Lorem { ipsum: dolor,
- sit: amet };
+ let (lorem, ipsum, ..) = (1, 2, 3, 4);
}
```
-See also: [`struct_lit_single_line`](#struct_lit_single_line), [`indent_style`](#indent_style).
+## `control_brace_style`
-### Where predicates
+Brace style for control flow constructs
-#### `"Block"` (default):
+- **Default value**: `"AlwaysSameLine"`
+- **Possible values**: `"AlwaysNextLine"`, `"AlwaysSameLine"`, `"ClosingNextLine"`
+- **Stable**: No (tracking issue: [#3377](https://github.com/rust-lang/rustfmt/issues/3377))
+
+#### `"AlwaysSameLine"` (default):
```rust
-fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
-where
- Ipsum: Eq,
- Dolor: Eq,
- Sit: Eq,
- Amet: Eq,
-{
- // body
+fn main() {
+ if lorem {
+ println!("ipsum!");
+ } else {
+ println!("dolor!");
+ }
}
```
-#### `"Visual"`:
+#### `"AlwaysNextLine"`:
```rust
-fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
- where Ipsum: Eq,
- Dolor: Eq,
- Sit: Eq,
- Amet: Eq
-{
- // body
+fn main() {
+ if lorem
+ {
+ println!("ipsum!");
+ }
+ else
+ {
+ println!("dolor!");
+ }
}
```
-## `use_small_heuristics`
+#### `"ClosingNextLine"`:
+
+```rust
+fn main() {
+ if lorem {
+ println!("ipsum!");
+ }
+ else {
+ println!("dolor!");
+ }
+}
+```
+
+## `disable_all_formatting`
+
+Don't reformat anything.
-Whether to use different formatting for items and expressions if they satisfy a heuristic notion of 'small'.
+Note that this option may be soft-deprecated in the future once the [ignore](#ignore) option is stabilized. Nightly toolchain users are encouraged to use [ignore](#ignore) instead when possible.
-- **Default value**: `Default`
-- **Possible values**: `Default`, `Off`, `Max`
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
- **Stable**: Yes
-#### `Default` (default):
+## `edition`
-```rust
-enum Lorem {
- Ipsum,
- Dolor(bool),
- Sit { amet: Consectetur, adipiscing: Elit },
-}
+Specifies which edition is used by the parser.
-fn main() {
- lorem(
- "lorem",
- "ipsum",
- "dolor",
- "sit",
- "amet",
- "consectetur",
- "adipiscing",
- );
+- **Default value**: `"2015"`
+- **Possible values**: `"2015"`, `"2018"`, `"2021"`
+- **Stable**: Yes
- let lorem = Lorem {
- ipsum: dolor,
- sit: amet,
- };
- let lorem = Lorem { ipsum: dolor };
+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:
- let lorem = if ipsum { dolor } else { sit };
-}
+```toml
+edition = "2018"
```
-#### `Off`:
+## `empty_item_single_line`
-```rust
-enum Lorem {
- Ipsum,
- Dolor(bool),
- Sit {
- amet: Consectetur,
- adipiscing: Elit,
- },
-}
+Put empty-body functions and impls on a single line
-fn main() {
- lorem("lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing");
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: [#3356](https://github.com/rust-lang/rustfmt/issues/3356))
- let lorem = Lorem {
- ipsum: dolor,
- sit: amet,
- };
+#### `true` (default):
- let lorem = if ipsum {
- dolor
- } else {
- sit
- };
-}
+```rust
+fn lorem() {}
+
+impl Lorem {}
```
-#### `Max`:
+#### `false`:
```rust
-enum Lorem {
- Ipsum,
- Dolor(bool),
- Sit { amet: Consectetur, adipiscing: Elit },
+fn lorem() {
}
-fn main() {
- lorem("lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing");
-
- let lorem = Lorem { ipsum: dolor, sit: amet };
-
- let lorem = if ipsum { dolor } else { sit };
+impl Lorem {
}
```
-## `binop_separator`
+See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
-Where to put a binary operator when a binary expression goes multiline.
-- **Default value**: `"Front"`
-- **Possible values**: `"Front"`, `"Back"`
-- **Stable**: No
+## `enum_discrim_align_threshold`
-#### `"Front"` (default):
+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.
-```rust
-fn main() {
- let or = foofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoo
- || barbarbarbarbarbarbarbarbarbarbarbarbarbarbarbar;
+Note that this is not how much whitespace is inserted, but instead the longest variant name that
+doesn't get ignored when aligning.
- let sum = 123456789012345678901234567890
- + 123456789012345678901234567890
- + 123456789012345678901234567890;
+- **Default value** : 0
+- **Possible values**: any positive integer
+- **Stable**: No (tracking issue: [#3372](https://github.com/rust-lang/rustfmt/issues/3372))
- let range = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
- ..bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;
+#### `0` (default):
+
+```rust
+enum Bar {
+ A = 0,
+ Bb = 1,
+ RandomLongVariantGoesHere = 10,
+ Ccc = 71,
+}
+
+enum Bar {
+ VeryLongVariantNameHereA = 0,
+ VeryLongVariantNameHereBb = 1,
+ VeryLongVariantNameHereCcc = 2,
}
```
-#### `"Back"`:
+#### `20`:
```rust
-fn main() {
- let or = foofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoo ||
- barbarbarbarbarbarbarbarbarbarbarbarbarbarbarbar;
-
- let sum = 123456789012345678901234567890 +
- 123456789012345678901234567890 +
- 123456789012345678901234567890;
+enum Foo {
+ A = 0,
+ Bb = 1,
+ RandomLongVariantGoesHere = 10,
+ Ccc = 2,
+}
- let range = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa..
- bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;
+enum Bar {
+ VeryLongVariantNameHereA = 0,
+ VeryLongVariantNameHereBb = 1,
+ VeryLongVariantNameHereCcc = 2,
}
```
-## `combine_control_expr`
-Combine control expressions with function calls.
+## `error_on_line_overflow`
-- **Default value**: `true`
+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
+refactoring your code to avoid long/complex expressions, usually by extracting a local variable or
+using a shorter name.
+
+- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: [#3391](https://github.com/rust-lang/rustfmt/issues/3391))
-#### `true` (default):
+See also [`max_width`](#max_width).
-```rust
-fn example() {
- // If
- foo!(if x {
- foo();
- } else {
- bar();
- });
+## `error_on_unformatted`
- // IfLet
- foo!(if let Some(..) = x {
- foo();
- } else {
- bar();
- });
+Error if unable to get comments or string literals within `max_width`, or they are left with
+trailing whitespaces.
- // While
- foo!(while x {
- foo();
- bar();
- });
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: [#3392](https://github.com/rust-lang/rustfmt/issues/3392))
+
+## `fn_args_layout`
+
+Control the layout of arguments in a function
+
+- **Default value**: `"Tall"`
+- **Possible values**: `"Compressed"`, `"Tall"`, `"Vertical"`
+- **Stable**: Yes
+
+#### `"Tall"` (default):
+
+```rust
+trait Lorem {
+ fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet);
- // WhileLet
- foo!(while let Some(..) = x {
- foo();
- bar();
- });
+ fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet) {
+ // body
+ }
- // ForLoop
- foo!(for x in y {
- foo();
- bar();
- });
+ fn lorem(
+ ipsum: Ipsum,
+ dolor: Dolor,
+ sit: Sit,
+ amet: Amet,
+ consectetur: Consectetur,
+ adipiscing: Adipiscing,
+ elit: Elit,
+ );
- // Loop
- foo!(loop {
- foo();
- bar();
- });
+ fn lorem(
+ ipsum: Ipsum,
+ dolor: Dolor,
+ sit: Sit,
+ amet: Amet,
+ consectetur: Consectetur,
+ adipiscing: Adipiscing,
+ elit: Elit,
+ ) {
+ // body
+ }
}
```
-#### `false`:
+#### `"Compressed"`:
```rust
-fn example() {
- // If
- foo!(
- if x {
- foo();
- } else {
- bar();
- }
- );
+trait Lorem {
+ fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet);
- // IfLet
- foo!(
- if let Some(..) = x {
- foo();
- } else {
- bar();
- }
- );
+ fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet) {
+ // body
+ }
- // While
- foo!(
- while x {
- foo();
- bar();
- }
+ fn lorem(
+ ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet, consectetur: Consectetur,
+ adipiscing: Adipiscing, elit: Elit,
);
- // WhileLet
- foo!(
- while let Some(..) = x {
- foo();
- bar();
- }
- );
+ fn lorem(
+ ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet, consectetur: Consectetur,
+ adipiscing: Adipiscing, elit: Elit,
+ ) {
+ // body
+ }
+}
+```
- // ForLoop
- foo!(
- for x in y {
- foo();
- bar();
- }
+#### `"Vertical"`:
+
+```rust
+trait Lorem {
+ fn lorem(
+ ipsum: Ipsum,
+ dolor: Dolor,
+ sit: Sit,
+ amet: Amet,
);
- // Loop
- foo!(
- loop {
- foo();
- bar();
- }
+ 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
+ }
}
```
-## `comment_width`
-
-Maximum length of comments. No effect unless`wrap_comments = true`.
-
-- **Default value**: `80`
-- **Possible values**: any positive integer
-- **Stable**: No
+## `fn_call_width`
-**Note:** A value of `0` results in [`wrap_comments`](#wrap_comments) being applied regardless of a line's width.
+Maximum width of the args of a function call before falling back to vertical formatting.
-#### `80` (default; comments shorter than `comment_width`):
-```rust
-// Lorem ipsum dolor sit amet, consectetur adipiscing elit.
-```
+- **Default value**: `60`
+- **Possible values**: any positive integer that is less than or equal to the value specified for [`max_width`](#max_width)
+- **Stable**: Yes
-#### `60` (comments longer than `comment_width`):
-```rust
-// Lorem ipsum dolor sit amet,
-// consectetur adipiscing elit.
-```
+By default this option is set as a percentage of [`max_width`](#max_width) provided by [`use_small_heuristics`](#use_small_heuristics), but a value set directly for `fn_call_width` will take precedence.
-See also [`wrap_comments`](#wrap_comments).
+See also [`max_width`](#max_width) and [`use_small_heuristics`](#use_small_heuristics)
-## `condense_wildcard_suffixes`
+## `fn_single_line`
-Replace strings of _ wildcards by a single .. in tuple patterns
+Put single-expression functions on a single line
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: [#3358](https://github.com/rust-lang/rustfmt/issues/3358))
#### `false` (default):
```rust
-fn main() {
- let (lorem, ipsum, _, _) = (1, 2, 3, 4);
- let (lorem, ipsum, ..) = (1, 2, 3, 4);
+fn lorem() -> usize {
+ 42
+}
+
+fn lorem() -> usize {
+ let ipsum = 42;
+ ipsum
}
```
#### `true`:
```rust
-fn main() {
- let (lorem, ipsum, ..) = (1, 2, 3, 4);
+fn lorem() -> usize { 42 }
+
+fn lorem() -> usize {
+ let ipsum = 42;
+ ipsum
}
```
-## `control_brace_style`
+See also [`control_brace_style`](#control_brace_style).
-Brace style for control flow constructs
-- **Default value**: `"AlwaysSameLine"`
-- **Possible values**: `"AlwaysNextLine"`, `"AlwaysSameLine"`, `"ClosingNextLine"`
-- **Stable**: No
+## `force_explicit_abi`
-#### `"AlwaysSameLine"` (default):
+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
-fn main() {
- if lorem {
- println!("ipsum!");
- } else {
- println!("dolor!");
- }
+extern "C" {
+ pub static lorem: c_int;
}
```
-#### `"AlwaysNextLine"`:
+#### `false`:
```rust
-fn main() {
- if lorem
- {
- println!("ipsum!");
- }
- else
- {
- println!("dolor!");
- }
+extern {
+ pub static lorem: c_int;
}
```
-#### `"ClosingNextLine"`:
+## `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](https://github.com/rust-lang/rustfmt/issues/3374))
+
+#### `false` (default):
```rust
fn main() {
- if lorem {
- println!("ipsum!");
- }
- else {
- println!("dolor!");
+ result.and_then(|maybe_value| match maybe_value {
+ None => foo(),
+ Some(value) => bar(),
+ });
+
+ match lorem {
+ None => |ipsum| {
+ println!("Hello World");
+ },
+ Some(dolor) => foo(),
}
}
```
-## `disable_all_formatting`
-
-Don't reformat anything
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
-
-## `error_on_line_overflow`
+#### `true`:
-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
-refactoring your code to avoid long/complex expressions, usually by extracting a local variable or
-using a shorter name.
+```rust
+fn main() {
+ result.and_then(|maybe_value| {
+ match maybe_value {
+ None => foo(),
+ Some(value) => bar(),
+ }
+ });
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+ match lorem {
+ None => {
+ |ipsum| {
+ println!("Hello World");
+ }
+ }
+ Some(dolor) => foo(),
+ }
+}
+```
-See also [`max_width`](#max_width).
-## `error_on_unformatted`
+## `format_code_in_doc_comments`
-Error if unable to get comments or string literals within `max_width`, or they are left with
-trailing whitespaces.
+Format code snippet included in doc comments.
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
-
-## `fn_args_density`
+- **Stable**: No (tracking issue: [#3348](https://github.com/rust-lang/rustfmt/issues/3348))
-Argument density in functions
+#### `false` (default):
-- **Default value**: `"Tall"`
-- **Possible values**: `"Compressed"`, `"Tall"`, `"Vertical"`
-- **Stable**: No
+```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
+}
+```
-#### `"Tall"` (default):
+#### `true`
```rust
-trait Lorem {
- fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet);
+/// 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: Ipsum, dolor: Dolor, sit: Sit, amet: Amet) {
- // body
- }
+## `format_generated_files`
- fn lorem(
- ipsum: Ipsum,
- dolor: Dolor,
- sit: Sit,
- amet: Amet,
- consectetur: Consectetur,
- adipiscing: Adipiscing,
- elit: Elit,
- );
+Format generated files. A file is considered generated
+if any of the first five lines contain a `@generated` comment marker.
- fn lorem(
- ipsum: Ipsum,
- dolor: Dolor,
- sit: Sit,
- amet: Amet,
- consectetur: Consectetur,
- adipiscing: Adipiscing,
- elit: Elit,
- ) {
- // body
- }
-}
-```
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: [#5080](https://github.com/rust-lang/rustfmt/issues/5080))
-#### `"Compressed"`:
+## `format_macro_matchers`
-```rust
-trait Lorem {
- fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet);
+Format the metavariable matching patterns in macros.
- fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet) {
- // body
- }
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: [#3354](https://github.com/rust-lang/rustfmt/issues/3354))
- fn lorem(
- ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet, consectetur: Consectetur,
- adipiscing: Adipiscing, elit: Elit,
- );
+#### `false` (default):
- fn lorem(
- ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet, consectetur: Consectetur,
- adipiscing: Adipiscing, elit: Elit,
- ) {
- // body
- }
+```rust
+macro_rules! foo {
+ ($a: ident : $b: ty) => {
+ $a(42): $b;
+ };
+ ($a: ident $b: ident $c: ident) => {
+ $a = $b + $c;
+ };
}
```
-#### `"Vertical"`:
+#### `true`:
```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
- }
+macro_rules! foo {
+ ($a:ident : $b:ty) => {
+ $a(42): $b;
+ };
+ ($a:ident $b:ident $c:ident) => {
+ $a = $b + $c;
+ };
}
```
+See also [`format_macro_bodies`](#format_macro_bodies).
-## `brace_style`
-Brace style for items
+## `format_macro_bodies`
-- **Default value**: `"SameLineWhere"`
-- **Possible values**: `"AlwaysNextLine"`, `"PreferSameLine"`, `"SameLineWhere"`
-- **Stable**: No
+Format the bodies of macros.
-### Functions
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: [#3355](https://github.com/rust-lang/rustfmt/issues/3355))
-#### `"SameLineWhere"` (default):
+#### `true` (default):
```rust
-fn lorem() {
- // body
+macro_rules! foo {
+ ($a: ident : $b: ty) => {
+ $a(42): $b;
+ };
+ ($a: ident $b: ident $c: ident) => {
+ $a = $b + $c;
+ };
}
+```
-fn lorem(ipsum: usize) {
- // body
-}
+#### `false`:
-fn lorem<T>(ipsum: T)
-where
- T: Add + Sub + Mul + Div,
-{
- // body
+```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).
-```rust
-fn lorem()
-{
- // body
-}
-fn lorem(ipsum: usize)
-{
- // body
-}
+## `format_strings`
-fn lorem<T>(ipsum: T)
-where
- T: Add + Sub + Mul + Div,
-{
- // body
-}
-```
+Format string literals where necessary
-#### `"PreferSameLine"`:
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: [#3353](https://github.com/rust-lang/rustfmt/issues/3353))
+
+#### `false` (default):
```rust
-fn lorem() {
- // body
+fn main() {
+ let lorem = "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet consectetur adipiscing";
}
+```
-fn lorem(ipsum: usize) {
- // body
-}
+#### `true`:
-fn lorem<T>(ipsum: T)
-where
- T: Add + Sub + Mul + Div, {
- // body
+```rust
+fn main() {
+ let lorem = "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet \
+ consectetur adipiscing";
}
```
-### Structs and enums
+See also [`max_width`](#max_width).
-#### `"SameLineWhere"` (default):
+## `hard_tabs`
-```rust
-struct Lorem {
- ipsum: bool,
-}
+Use tab characters for indentation, spaces for alignment
-struct Dolor<T>
-where
- T: Eq,
-{
- sit: T,
-}
-```
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: Yes
-#### `"AlwaysNextLine"`:
+#### `false` (default):
```rust
-struct Lorem
-{
- ipsum: bool,
-}
-
-struct Dolor<T>
-where
- T: Eq,
-{
- sit: T,
+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).
+
+## `hex_literal_case`
-## `empty_item_single_line`
+Control the case of the letters in hexadecimal literal values
-Put empty-body functions and impls on a single line
+- **Default value**: `Preserve`
+- **Possible values**: `Upper`, `Lower`
+- **Stable**: No (tracking issue: [#5081](https://github.com/rust-lang/rustfmt/issues/5081))
-- **Default value**: `true`
+## `hide_parse_errors`
+
+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](https://github.com/rust-lang/rustfmt/issues/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](https://github.com/rust-lang/rustfmt/issues/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](https://github.com/rust-lang/rustfmt/issues/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](https://github.com/rust-lang/rustfmt/issues/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](https://github.com/rust-lang/rustfmt/issues/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).
+### Control flow
+#### `"Block"` (default):
-## `force_explicit_abi`
+```rust
+fn main() {
+ if lorem_ipsum
+ && dolor_sit
+ && amet_consectetur
+ && lorem_sit
+ && dolor_consectetur
+ && amet_ipsum
+ && lorem_consectetur
+ {
+ // ...
+ }
+}
+```
-Always print the abi for extern items
+#### `"Visual"`:
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
+```rust
+fn main() {
+ if lorem_ipsum
+ && dolor_sit
+ && amet_consectetur
+ && lorem_sit
+ && dolor_consectetur
+ && amet_ipsum
+ && lorem_consectetur
+ {
+ // ...
+ }
+}
+```
-**Note:** Non-"C" ABIs are always printed. If `false` then "C" is removed.
+See also: [`control_brace_style`](#control_brace_style).
-#### `true` (default):
+### Function arguments
+
+#### `"Block"` (default):
```rust
-extern "C" {
- pub static lorem: c_int;
+fn lorem() {}
+
+fn lorem(ipsum: usize) {}
+
+fn lorem(
+ ipsum: usize,
+ dolor: usize,
+ sit: usize,
+ amet: usize,
+ consectetur: usize,
+ adipiscing: usize,
+ elit: usize,
+) {
+ // body
}
```
-#### `false`:
+#### `"Visual"`:
```rust
-extern {
- pub static lorem: c_int;
-}
-```
+fn lorem() {}
-## `format_strings`
+fn lorem(ipsum: usize) {}
-Format string literals where necessary
+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
fn main() {
- let lorem =
- "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet consectetur adipiscing";
+ lorem(
+ "lorem",
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit",
+ );
}
```
-#### `true`:
+#### `"Visual"`:
```rust
fn main() {
- let lorem = "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet \
- consectetur adipiscing";
+ lorem("lorem",
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit");
}
```
-See also [`max_width`](#max_width).
-
-## `format_macro_matchers`
-
-Format the metavariable matching patterns in macros.
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+### Generics
-#### `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 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
}
```
-#### `true`:
+#### `"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_bodies`](#format_macro_bodies).
-
-
-## `format_macro_bodies`
-
-Format the bodies of macros.
-
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+#### Struct
-#### `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 main() {
+ let lorem = Lorem {
+ ipsum: dolor,
+ sit: amet,
};
}
```
-#### `false`:
+#### `"Visual"`:
```rust
-macro_rules! foo {
- ($a: ident : $b: ty) => { $a(42): $b; };
- ($a: ident $b: ident $c: ident) => { $a=$b+$c; };
+fn main() {
+ let lorem = Lorem { ipsum: dolor,
+ sit: amet };
}
```
-See also [`format_macro_matchers`](#format_macro_matchers).
-
-
-## `hard_tabs`
-
-Use tab characters for indentation, spaces for alignment
+See also: [`struct_lit_single_line`](#struct_lit_single_line), [`indent_style`](#indent_style).
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
+### Where predicates
-#### `false` (default):
+#### `"Block"` (default):
```rust
-fn lorem() -> usize {
- 42 // spaces before 42
+fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
+where
+ Ipsum: Eq,
+ Dolor: Eq,
+ Sit: Eq,
+ Amet: Eq,
+{
+ // body
}
```
-#### `true`:
+#### `"Visual"`:
```rust
-fn lorem() -> usize {
- 42 // tabs before 42
+fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
+ where Ipsum: Eq,
+ Dolor: Eq,
+ Sit: Eq,
+ Amet: Eq
+{
+ // body
}
```
-See also: [`tab_spaces`](#tab_spaces).
-
-
-## `imports_indent`
+## `inline_attribute_width`
-Indent style of imports
+Write an item and its attribute on the same line if their combined width is below a threshold
-- **Default Value**: `"Block"`
-- **Possible values**: `"Block"`, `"Visual"`
-- **Stable**: No
+- **Default value**: 0
+- **Possible values**: any positive integer
+- **Stable**: No (tracking issue: [#3343](https://github.com/rust-lang/rustfmt/issues/3343))
-#### `"Block"` (default):
+### Example
+#### `0` (default):
```rust
-use foo::{
- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy,
- zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
-};
+#[cfg(feature = "alloc")]
+use core::slice;
```
-#### `"Visual"`:
-
+#### `50`:
```rust
-use foo::{xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy,
- zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz};
+#[cfg(feature = "alloc")] use core::slice;
```
-See also: [`imports_layout`](#imports_layout).
-
-## `imports_layout`
-
-Item layout inside a imports block
+## `license_template_path`
-- **Default value**: "Mixed"
-- **Possible values**: "Horizontal", "HorizontalVertical", "Mixed", "Vertical"
-- **Stable**: No
+Check whether beginnings of files match a license template.
-#### `"Mixed"` (default):
+- **Default value**: `""`
+- **Possible values**: path to a license template file
+- **Stable**: No (tracking issue: [#3352](https://github.com/rust-lang/rustfmt/issues/3352))
-```rust
-use foo::{xxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyy, zzzzzzzzzzzzzzzzzz};
+A license template is a plain text file which is matched literally against the
+beginning of each source file, except for `{}`-delimited blocks, which are
+matched as regular expressions. The following license template therefore
+matches strings like `// Copyright 2017 The Rust Project Developers.`, `//
+Copyright 2018 The Rust Project Developers.`, etc.:
-use foo::{
- aaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbb, cccccccccccccccccc, dddddddddddddddddd,
- eeeeeeeeeeeeeeeeee, ffffffffffffffffff,
-};
+```
+// Copyright {\d+} The Rust Project Developers.
```
-#### `"Horizontal"`:
+`\{`, `\}` and `\\` match literal braces / backslashes.
-**Note**: This option forces all imports onto one line and may exceed `max_width`.
+## `match_arm_blocks`
-```rust
-use foo::{xxx, yyy, zzz};
+Controls whether arm bodies are wrapped in cases where the first line of the body cannot fit on the same line as the `=>` operator.
-use foo::{aaa, bbb, ccc, ddd, eee, fff};
-```
+The Style Guide requires that bodies are block wrapped by default if a line break is required after the `=>`, but this option can be used to disable that behavior to prevent wrapping arm bodies in that event, so long as the body does not contain multiple statements nor line comments.
-#### `"HorizontalVertical"`:
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: [#3373](https://github.com/rust-lang/rustfmt/issues/3373))
-```rust
-use foo::{xxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyy, zzzzzzzzzzzzzzzzzz};
+#### `true` (default):
-use foo::{
- aaaaaaaaaaaaaaaaaa,
- bbbbbbbbbbbbbbbbbb,
- cccccccccccccccccc,
- dddddddddddddddddd,
- eeeeeeeeeeeeeeeeee,
- ffffffffffffffffff,
-};
+```rust
+fn main() {
+ match lorem {
+ ipsum => {
+ foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x)
+ }
+ dolor => println!("{}", sit),
+ sit => foo(
+ "foooooooooooooooooooooooo",
+ "baaaaaaaaaaaaaaaaaaaaaaaarr",
+ "baaaaaaaaaaaaaaaaaaaazzzzzzzzzzzzz",
+ "qqqqqqqqquuuuuuuuuuuuuuuuuuuuuuuuuuxxx",
+ ),
+ }
+}
```
-#### `"Vertical"`:
+#### `false`:
```rust
-use foo::{
- xxx,
- yyy,
- zzz,
-};
-
-use foo::{
- aaa,
- bbb,
- ccc,
- ddd,
- eee,
- fff,
-};
+fn main() {
+ match lorem {
+ lorem =>
+ foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x),
+ ipsum => println!("{}", sit),
+ sit => foo(
+ "foooooooooooooooooooooooo",
+ "baaaaaaaaaaaaaaaaaaaaaaaarr",
+ "baaaaaaaaaaaaaaaaaaaazzzzzzzzzzzzz",
+ "qqqqqqqqquuuuuuuuuuuuuuuuuuuuuuuuuuxxx",
+ ),
+ }
+}
```
-## `merge_imports`
+See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
-Merge multiple imports into a single nested import.
+## `match_arm_leading_pipes`
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+Controls whether to include a leading pipe on match arms
-#### `false` (default):
+- **Default value**: `Never`
+- **Possible values**: `Always`, `Never`, `Preserve`
+- **Stable**: Yes
-```rust
-use foo::{a, c, d};
-use foo::{b, g};
-use foo::{e, f};
+#### `Never` (default):
+```rust
+// Leading pipes are removed from this:
+// fn foo() {
+// match foo {
+// | "foo" | "bar" => {}
+// | "baz"
+// | "something relatively long"
+// | "something really really really realllllllllllllly long" => println!("x"),
+// | "qux" => println!("y"),
+// _ => {}
+// }
+// }
+
+// Becomes
+fn foo() {
+ match foo {
+ "foo" | "bar" => {}
+ "baz"
+ | "something relatively long"
+ | "something really really really realllllllllllllly long" => println!("x"),
+ "qux" => println!("y"),
+ _ => {}
+ }
+}
```
-#### `true`:
-
+#### `Always`:
```rust
-use foo::{a, b, c, d, e, f, g};
+// Leading pipes are emitted on all arms of this:
+// fn foo() {
+// match foo {
+// "foo" | "bar" => {}
+// "baz"
+// | "something relatively long"
+// | "something really really really realllllllllllllly long" => println!("x"),
+// "qux" => println!("y"),
+// _ => {}
+// }
+// }
+
+// Becomes:
+fn foo() {
+ match foo {
+ | "foo" | "bar" => {}
+ | "baz"
+ | "something relatively long"
+ | "something really really really realllllllllllllly long" => println!("x"),
+ | "qux" => println!("y"),
+ | _ => {}
+ }
+}
```
+#### `Preserve`:
+```rust
+fn foo() {
+ match foo {
+ | "foo" | "bar" => {}
+ | "baz"
+ | "something relatively long"
+ | "something really really really realllllllllllllly long" => println!("x"),
+ | "qux" => println!("y"),
+ _ => {}
+ }
+
+ match baz {
+ "qux" => {}
+ "foo" | "bar" => {}
+ _ => {}
+ }
+}
+```
## `match_block_trailing_comma`
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: Yes
#### `false` (default):
#### `false`:
```rust
+#[derive(Eq, PartialEq, Debug, Copy, Clone)]
+pub enum Bar {}
+
#[derive(Eq, PartialEq)]
#[derive(Debug)]
#[derive(Copy, Clone)]
pub enum Foo {}
```
-## `force_multiline_blocks`
+## `imports_granularity`
-Force multiline closure and match arm bodies to be wrapped in a block
+How imports should be grouped into `use` statements. Imports will be merged or split to the configured level of granularity.
+
+- **Default value**: `Preserve`
+- **Possible values**: `Preserve`, `Crate`, `Module`, `Item`, `One`
+- **Stable**: No (tracking issue: [#4991](https://github.com/rust-lang/rustfmt/issues/4991))
+
+#### `Preserve` (default):
+
+Do not change the granularity of any imports and preserve the original structure written by the developer.
+
+```rust
+use foo::b;
+use foo::b::{f, g};
+use foo::{a, c, d::e};
+use qux::{h, i};
+```
+
+#### `Crate`:
+
+Merge imports from the same crate into a single `use` statement. Conversely, imports from different crates are split into separate statements.
+
+```rust
+use foo::{
+ a, b,
+ b::{f, g},
+ c,
+ d::e,
+};
+use qux::{h, i};
+```
+
+#### `Module`:
+
+Merge imports from the same module into a single `use` statement. Conversely, imports from different modules are split into separate statements.
+
+```rust
+use foo::b::{f, g};
+use foo::d::e;
+use foo::{a, b, c};
+use qux::{h, i};
+```
+
+#### `Item`:
+
+Flatten imports so that each has its own `use` statement.
+
+```rust
+use foo::a;
+use foo::b;
+use foo::b::f;
+use foo::b::g;
+use foo::c;
+use foo::d::e;
+use qux::h;
+use qux::i;
+```
+
+#### `One`:
+
+Merge all imports into a single `use` statement as long as they have the same visibility.
+
+```rust
+pub use foo::{x, y};
+use {
+ bar::{
+ a,
+ b::{self, f, g},
+ c,
+ d::e,
+ },
+ qux::{h, i},
+};
+```
+
+## `merge_imports`
+
+This option is deprecated. Use `imports_granularity = "Crate"` instead.
- **Default value**: `false`
-- **Possible values**: `false`, `true`
-- **Stable**: No
+- **Possible values**: `true`, `false`
#### `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};
```
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: [#3350](https://github.com/rust-lang/rustfmt/issues/3350))
#### `false` (default):
fn adipiscing() -> usize {}
```
+## `normalize_doc_attributes`
+
+Convert `#![doc]` and `#[doc]` attributes to `//!` and `///` doc comments.
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: [#3351](https://github.com/rust-lang/rustfmt/issues/3351))
+
+#### `false` (default):
+
+```rust
+#![doc = "Example documentation"]
+
+#[doc = "Example item documentation"]
+pub enum Bar {}
+
+/// Example item documentation
+pub enum Foo {}
+```
+
+#### `true`:
+
+```rust
+//! Example documentation
+
+/// Example item documentation
+pub enum Foo {}
+```
+
+## `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.
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: [#3370](https://github.com/rust-lang/rustfmt/issues/3370))
+
+#### `false` (default):
+
+```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,
+ ],
+ );
+}
+```
+
+#### `true`:
+
+```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,
+ ]);
+}
+```
+
## `remove_nested_parens`
Remove nested parens.
#### `false`:
```rust
fn main() {
+ (foo());
+
((((foo()))));
}
```
+## `reorder_impl_items`
+
+Reorder impl items. `type` and `const` are put first, then macros and methods.
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: [#3363](https://github.com/rust-lang/rustfmt/issues/3363))
+
+#### `false` (default)
+
+```rust
+struct Dummy;
+
+impl Iterator for Dummy {
+ fn next(&mut self) -> Option<Self::Item> {
+ None
+ }
+
+ type Item = i32;
+}
+
+impl Iterator for Dummy {
+ type Item = i32;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ None
+ }
+}
+```
+
+#### `true`
+
+```rust
+struct Dummy;
+
+impl Iterator for Dummy {
+ type Item = i32;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ None
+ }
+}
+```
+
## `reorder_imports`
Reorder import and extern crate statements alphabetically in groups (a group is
use sit;
```
+## `group_imports`
-## `reorder_modules`
+Controls the strategy for how imports are grouped together.
-Reorder `mod` declarations alphabetically in group.
+- **Default value**: `Preserve`
+- **Possible values**: `Preserve`, `StdExternalCrate`, `One`
+- **Stable**: No (tracking issue: [#5083](https://github.com/rust-lang/rustfmt/issues/5083))
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
+#### `Preserve` (default):
-#### `true` (default)
+Preserve the source file's import groups.
```rust
-mod a;
-mod b;
+use super::update::convert_publish_payload;
+use chrono::Utc;
-mod dolor;
-mod ipsum;
-mod lorem;
-mod sit;
+use alloc::alloc::Layout;
+use juniper::{FieldError, FieldResult};
+use uuid::Uuid;
+
+use std::sync::Arc;
+
+use broker::database::PooledConnection;
+
+use super::schema::{Context, Payload};
+use crate::models::Event;
+use core::f32;
```
-#### `false`
+#### `StdExternalCrate`:
+
+Discard existing import groups, and create three groups for:
+1. `std`, `core` and `alloc`,
+2. external crates,
+3. `self`, `super` and `crate` imports.
```rust
-mod b;
-mod a;
+use alloc::alloc::Layout;
+use core::f32;
+use std::sync::Arc;
-mod lorem;
-mod ipsum;
-mod dolor;
-mod sit;
+use broker::database::PooledConnection;
+use chrono::Utc;
+use juniper::{FieldError, FieldResult};
+use uuid::Uuid;
+
+use super::schema::{Context, Payload};
+use super::update::convert_publish_payload;
+use crate::models::Event;
```
-**Note** `mod` with `#[macro_export]` will not be reordered since that could change the semantic
-of the original source code.
+#### `One`:
-## `reorder_impl_items`
+Discard existing import groups, and create a single group for everything
-Reorder impl items. `type` and `const` are put first, then macros and methods.
+```rust
+use super::schema::{Context, Payload};
+use super::update::convert_publish_payload;
+use crate::models::Event;
+use alloc::alloc::Layout;
+use broker::database::PooledConnection;
+use chrono::Utc;
+use core::f32;
+use juniper::{FieldError, FieldResult};
+use std::sync::Arc;
+use uuid::Uuid;
+```
-- **Default value**: `false`
+## `reorder_modules`
+
+Reorder `mod` declarations alphabetically in group.
+
+- **Default value**: `true`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: Yes
-#### `false` (default)
+#### `true` (default)
```rust
-struct Dummy;
-
-impl Iterator for Dummy {
- fn next(&mut self) -> Option<Self::Item> {
- None
- }
+mod a;
+mod b;
- type Item = i32;
-}
+mod dolor;
+mod ipsum;
+mod lorem;
+mod sit;
```
-#### `true`
+#### `false`
```rust
-struct Dummy;
-
-impl Iterator for Dummy {
- type Item = i32;
+mod b;
+mod a;
- fn next(&mut self) -> Option<Self::Item> {
- None
- }
-}
+mod lorem;
+mod ipsum;
+mod dolor;
+mod sit;
```
-## `report_todo`
+**Note** `mod` with `#[macro_export]` will not be reordered since that could change the semantics
+of the original source code.
-Report `TODO` items in comments.
+## `report_fixme`
+
+Report `FIXME` items in comments.
- **Default value**: `"Never"`
- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
-- **Stable**: No
+- **Stable**: No (tracking issue: [#3394](https://github.com/rust-lang/rustfmt/issues/3394))
-Warns about any comments containing `TODO` in them when set to `"Always"`. If
+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
-`TODO`, `"Unnumbered"` will ignore it.
+`FIXME`, `"Unnumbered"` will ignore it.
-See also [`report_fixme`](#report_fixme).
+See also [`report_todo`](#report_todo).
-## `report_fixme`
-Report `FIXME` items in comments.
+## `report_todo`
+
+Report `TODO` items in comments.
- **Default value**: `"Never"`
- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
-- **Stable**: No
+- **Stable**: No (tracking issue: [#3393](https://github.com/rust-lang/rustfmt/issues/3393))
-Warns about any comments containing `FIXME` in them when set to `"Always"`. If
+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
-`FIXME`, `"Unnumbered"` will ignore it.
+`TODO`, `"Unnumbered"` will ignore it.
-See also [`report_todo`](#report_todo).
+See also [`report_fixme`](#report_fixme).
+
+## `required_version`
+Require a specific version of rustfmt. If you want to make sure that the
+specific version of rustfmt is used in your CI, use this option.
+
+- **Default value**: `CARGO_PKG_VERSION`
+- **Possible values**: any published version (e.g. `"0.3.8"`)
+- **Stable**: No (tracking issue: [#3386](https://github.com/rust-lang/rustfmt/issues/3386))
## `skip_children`
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: [#3389](https://github.com/rust-lang/rustfmt/issues/3386))
+
+## `single_line_if_else_max_width`
+
+Maximum line length for single line if-else expressions. A value of `0` (zero) results in if-else expressions always being broken into multiple lines. Note this occurs when `use_small_heuristics` is set to `Off`.
+
+- **Default value**: `50`
+- **Possible values**: any positive integer that is less than or equal to the value specified for [`max_width`](#max_width)
+- **Stable**: Yes
+
+By default this option is set as a percentage of [`max_width`](#max_width) provided by [`use_small_heuristics`](#use_small_heuristics), but a value set directly for `single_line_if_else_max_width` will take precedence.
+
+See also [`max_width`](#max_width) and [`use_small_heuristics`](#use_small_heuristics)
## `space_after_colon`
- **Default value**: `true`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: [#3366](https://github.com/rust-lang/rustfmt/issues/3366))
#### `true` (default):
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: [#3365](https://github.com/rust-lang/rustfmt/issues/3365))
#### `false` (default):
See also: [`space_after_colon`](#space_after_colon).
-## `struct_field_align_threshold`
-
-The maximum diff of width between struct fields to be aligned with each other.
-
-- **Default value** : 0
-- **Possible values**: any positive integer
-- **Stable**: No
-
-#### `0` (default):
-
-```rust
-struct Foo {
- x: u32,
- yy: u32,
- zzz: u32,
-}
-```
-
-#### `20`:
-
-```rust
-struct Foo {
- x: u32,
- yy: u32,
- zzz: u32,
-}
-```
-
## `spaces_around_ranges`
Put spaces around the .., ..=, and ... range operators
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: [#3367](https://github.com/rust-lang/rustfmt/issues/3367))
#### `false` (default):
}
```
+## `struct_field_align_threshold`
+
+The maximum diff of width between struct fields to be aligned with each other.
+
+- **Default value** : 0
+- **Possible values**: any non-negative integer
+- **Stable**: No (tracking issue: [#3371](https://github.com/rust-lang/rustfmt/issues/3371))
+
+#### `0` (default):
+
+```rust
+struct Foo {
+ x: u32,
+ yy: u32,
+ zzz: u32,
+}
+```
+
+#### `20`:
+
+```rust
+struct Foo {
+ x: u32,
+ yy: u32,
+ zzz: u32,
+}
+```
+
## `struct_lit_single_line`
Put small struct literals on a single line
- **Default value**: `true`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: [#3357](https://github.com/rust-lang/rustfmt/issues/3357))
#### `true` (default):
See also: [`indent_style`](#indent_style).
+## `struct_lit_width`
+
+Maximum width in the body of a struct literal before falling back to vertical formatting. A value of `0` (zero) results in struct literals always being broken into multiple lines. Note this occurs when `use_small_heuristics` is set to `Off`.
+
+- **Default value**: `18`
+- **Possible values**: any positive integer that is less than or equal to the value specified for [`max_width`](#max_width)
+- **Stable**: Yes
+
+By default this option is set as a percentage of [`max_width`](#max_width) provided by [`use_small_heuristics`](#use_small_heuristics), but a value set directly for `struct_lit_width` will take precedence.
+
+See also [`max_width`](#max_width), [`use_small_heuristics`](#use_small_heuristics), and [`struct_lit_single_line`](#struct_lit_single_line)
+
+## `struct_variant_width`
+
+Maximum width in the body of a struct variant before falling back to vertical formatting. A value of `0` (zero) results in struct literals always being broken into multiple lines. Note this occurs when `use_small_heuristics` is set to `Off`.
+
+- **Default value**: `35`
+- **Possible values**: any positive integer that is less than or equal to the value specified for [`max_width`](#max_width)
+- **Stable**: Yes
+
+By default this option is set as a percentage of [`max_width`](#max_width) provided by [`use_small_heuristics`](#use_small_heuristics), but a value set directly for `struct_variant_width` will take precedence.
+
+See also [`max_width`](#max_width) and [`use_small_heuristics`](#use_small_heuristics)
## `tab_spaces`
- **Default value**: `"Vertical"`
- **Possible values**: `"Always"`, `"Never"`, `"Vertical"`
-- **Stable**: No
+- **Stable**: No (tracking issue: [#3379](https://github.com/rust-lang/rustfmt/issues/3379))
#### `"Vertical"` (default):
- **Default value**: `true`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: [#3378](https://github.com/rust-lang/rustfmt/issues/3378))
#### `true` (default):
```rust
- **Default value**: `"Wide"`
- **Possible values**: `"Compressed"`, `"Wide"`
-- **Stable**: No
+- **Stable**: No (tracking issue: [#3364](https://github.com/rust-lang/rustfmt/issues/3364))
#### `"Wide"` (default):
```rust
fn lorem<Ipsum: Dolor + Sit = Amet>() {
// body
-}
-```
-
-#### `"Compressed"`:
-
-```rust
-fn lorem<Ipsum: Dolor+Sit=Amet>() {
- // body
-}
-```
-
-## `use_field_init_shorthand`
-
-Use field initialize shorthand if possible.
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
-
-#### `false` (default):
-
-```rust
-struct Foo {
- x: u32,
- y: u32,
- z: u32,
-}
-
-fn main() {
- let x = 1;
- let y = 2;
- let z = 3;
- let a = Foo { x: x, y: y, z: z };
-}
-```
-
-#### `true`:
-
-```rust
-struct Foo {
- x: u32,
- y: u32,
- z: u32,
-}
-
-fn main() {
- let x = 1;
- let y = 2;
- let z = 3;
- let a = Foo { x, y, z };
-}
-```
-
-## `use_try_shorthand`
-
-Replace uses of the try! macro by the ? shorthand
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: Yes
-
-#### `false` (default):
-
-```rust
-fn main() {
- let lorem = try!(ipsum.map(|dolor| dolor.sit()));
-}
-```
-
-#### `true`:
-
-```rust
-fn main() {
- let lorem = ipsum.map(|dolor| dolor.sit())?;
-}
-```
-
-
-## `wrap_comments`
-
-Break comments to fit on the line
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
-
-#### `false` (default):
-
-```rust
-// Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
-```
-
-#### `true`:
-
-```rust
-// Lorem ipsum dolor sit amet, consectetur adipiscing elit,
-// sed do eiusmod tempor incididunt ut labore et dolore
-// magna aliqua. Ut enim ad minim veniam, quis nostrud
-// exercitation ullamco laboris nisi ut aliquip ex ea
-// commodo consequat.
-```
-
-## `match_arm_blocks`
-
-Wrap the body of arms in blocks when it does not fit on the same line with the pattern of arms
-
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-- **Stable**: No
-
-#### `true` (default):
-
-```rust
-fn main() {
- match lorem {
- true => {
- foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x)
- }
- false => println!("{}", sit),
- }
-}
-```
-
-#### `false`:
-
-```rust
-fn main() {
- match lorem {
- true =>
- foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x),
- false => println!("{}", sit),
- }
-}
-```
-
-See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
-
-
-## `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:
+#### `"Compressed"`:
```rust
-#![rustfmt::skip]
-
-fn foo() {
- println!("a");
+fn lorem<Ipsum: Dolor+Sit=Amet>() {
+ // body
}
+```
+## `unstable_features`
+Enable unstable features on the unstable channel.
-fn bar() {
- println!("b");
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: [#3387](https://github.com/rust-lang/rustfmt/issues/3387))
+## `use_field_init_shorthand`
- println!("c");
-}
-```
+Use field initialize shorthand if possible.
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: Yes
+
+#### `false` (default):
-#### `1` (default):
```rust
-fn foo() {
- println!("a");
+struct Foo {
+ x: u32,
+ y: u32,
+ z: u32,
}
-fn bar() {
- println!("b");
-
- println!("c");
+fn main() {
+ let x = 1;
+ let y = 2;
+ let z = 3;
+ let a = Foo { x, y, z };
+ let b = Foo { x: x, y: y, z: z };
}
```
-#### `2`:
+#### `true`:
+
```rust
-fn foo() {
- println!("a");
+struct Foo {
+ x: u32,
+ y: u32,
+ z: u32,
}
-
-fn bar() {
- println!("b");
-
-
- println!("c");
+fn main() {
+ let x = 1;
+ let y = 2;
+ let z = 3;
+ let a = Foo { x, y, z };
}
```
-See also: [`blank_lines_lower_bound`](#blank_lines_lower_bound)
+## `use_small_heuristics`
-## `blank_lines_lower_bound`
+This option can be used to simplify the management and bulk updates of the granular width configuration settings ([`fn_call_width`](#fn_call_width), [`attr_fn_like_width`](#attr_fn_like_width), [`struct_lit_width`](#struct_lit_width), [`struct_variant_width`](#struct_variant_width), [`array_width`](#array_width), [`chain_width`](#chain_width), [`single_line_if_else_max_width`](#single_line_if_else_max_width)), that respectively control when formatted constructs are multi-lined/vertical based on width.
-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.
+Note that explicitly provided values for the width configuration settings take precedence and override the calculated values determined by `use_small_heuristics`.
-- **Default value**: `0`
-- **Possible values**: *unsigned integer*
-- **Stable**: No
+- **Default value**: `"Default"`
+- **Possible values**: `"Default"`, `"Off"`, `"Max"`
+- **Stable**: Yes
-### Example
-Original Code (rustfmt will not change it with the default value of `0`):
+#### `Default` (default):
+When `use_small_heuristics` is set to `Default`, the values for the granular width settings are calculated as a ratio of the value for `max_width`.
+
+The ratios are:
+* [`fn_call_width`](#fn_call_width) - `60%`
+* [`attr_fn_like_width`](#attr_fn_like_width) - `70%`
+* [`struct_lit_width`](#struct_lit_width) - `18%`
+* [`struct_variant_width`](#struct_variant_width) - `35%`
+* [`array_width`](#array_width) - `60%`
+* [`chain_width`](#chain_width) - `60%`
+* [`single_line_if_else_max_width`](#single_line_if_else_max_width) - `50%`
+
+For example when `max_width` is set to `100`, the width settings are:
+* `fn_call_width=60`
+* `attr_fn_like_width=70`
+* `struct_lit_width=18`
+* `struct_variant_width=35`
+* `array_width=60`
+* `chain_width=60`
+* `single_line_if_else_max_width=50`
+
+and when `max_width` is set to `200`:
+* `fn_call_width=120`
+* `attr_fn_like_width=140`
+* `struct_lit_width=36`
+* `struct_variant_width=70`
+* `array_width=120`
+* `chain_width=120`
+* `single_line_if_else_max_width=100`
```rust
-#![rustfmt::skip]
-
-fn foo() {
- println!("a");
+enum Lorem {
+ Ipsum,
+ Dolor(bool),
+ Sit { amet: Consectetur, adipiscing: Elit },
}
-fn bar() {
- println!("b");
- println!("c");
+
+fn main() {
+ lorem(
+ "lorem",
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ );
+
+ let lorem = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
+ let lorem = Lorem { ipsum: dolor };
+
+ let lorem = if ipsum { dolor } else { sit };
}
```
-#### `1`
-```rust
-fn foo() {
+#### `Off`:
+When `use_small_heuristics` is set to `Off`, the granular width settings are functionally disabled and ignored. See the documentation for the respective width config options for specifics.
- println!("a");
+```rust
+enum Lorem {
+ Ipsum,
+ Dolor(bool),
+ Sit {
+ amet: Consectetur,
+ adipiscing: Elit,
+ },
}
-fn bar() {
+fn main() {
+ lorem("lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing");
- println!("b");
+ let lorem = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
- println!("c");
+ let lorem = if ipsum {
+ dolor
+ } else {
+ sit
+ };
}
```
+#### `Max`:
+When `use_small_heuristics` is set to `Max`, then each granular width setting is set to the same value as `max_width`.
-## `required_version`
-
-Require a specific version of rustfmt. If you want to make sure that the
-specific version of rustfmt is used in your CI, use this option.
-
-- **Default value**: `CARGO_PKG_VERSION`
-- **Possible values**: any published version (e.g. `"0.3.8"`)
-- **Stable**: No
+So if `max_width` is set to `200`, then all the width settings are also set to `200`.
+* `fn_call_width=200`
+* `attr_fn_like_width=200`
+* `struct_lit_width=200`
+* `struct_variant_width=200`
+* `array_width=200`
+* `chain_width=200`
+* `single_line_if_else_max_width=200`
-## `hide_parse_errors`
+```rust
+enum Lorem {
+ Ipsum,
+ Dolor(bool),
+ Sit { amet: Consectetur, adipiscing: Elit },
+}
-Do not show parse errors if the parser failed to parse files.
+fn main() {
+ lorem("lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing");
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-- **Stable**: No
+ let lorem = Lorem { ipsum: dolor, sit: amet };
-## `color`
+ let lorem = if ipsum { dolor } else { sit };
+}
+```
-Whether to use colored output or not.
-- **Default value**: `"Auto"`
-- **Possible values**: "Auto", "Always", "Never"
-- **Stable**: No
+See also:
+* [`max_width`](#max_width)
+* [`fn_call_width`](#fn_call_width)
+* [`attr_fn_like_width`](#attr_fn_like_width)
+* [`struct_lit_width`](#struct_lit_width)
+* [`struct_variant_width`](#struct_variant_width)
+* [`array_width`](#array_width)
+* [`chain_width`](#chain_width)
+* [`single_line_if_else_max_width`](#single_line_if_else_max_width)
-## `unstable_features`
+## `use_try_shorthand`
-Enable unstable features on stable channel.
+Replace uses of the try! macro by the ? shorthand
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: Yes
-## `license_template_path`
+#### `false` (default):
-Check whether beginnings of files match a license template.
+```rust
+fn main() {
+ let lorem = ipsum.map(|dolor| dolor.sit())?;
-- **Default value**: `""``
-- **Possible values**: path to a license template file
-- **Stable**: No
+ let lorem = try!(ipsum.map(|dolor| dolor.sit()));
+}
+```
-A license template is a plain text file which is matched literally against the
-beginning of each source file, except for `{}`-delimited blocks, which are
-matched as regular expressions. The following license template therefore
-matches strings like `// Copyright 2017 The Rust Project Developers.`, `//
-Copyright 2018 The Rust Project Developers.`, etc.:
+#### `true`:
+```rust
+fn main() {
+ let lorem = ipsum.map(|dolor| dolor.sit())?;
+}
```
-// Copyright {\d+} The Rust Project Developers.
-```
-
-`\{`, `\}` and `\\` match literal braces / backslashes.
-## `ignore`
+## `version`
-Skip formatting the specified files and directories.
+Which version of the formatting rules to use. `Version::One` is backwards-compatible
+with Rustfmt 1.0. Other versions are only backwards compatible within a major
+version number.
-- **Default value**: format every files
-- **Possible values**: See an example below
-- **Stable**: No
+- **Default value**: `One`
+- **Possible values**: `One`, `Two`
+- **Stable**: No (tracking issue: [#3383](https://github.com/rust-lang/rustfmt/issues/3383))
### Example
-If you want to ignore specific files, put the following to your config file:
-
```toml
-ignore = [
- "src/types.rs",
- "src/foo/bar.rs",
-]
+version = "Two"
```
-If you want to ignore every file under `examples/`, put the following to your config file:
-
-```toml
-ignore = [
- "examples",
-]
-```
+## `where_single_line`
-## `edition`
+Forces the `where` clause to be laid out on a single line.
-Specifies which edition is used by the parser.
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No (tracking issue: [#3359](https://github.com/rust-lang/rustfmt/issues/3359))
-- **Default value**: `2015`
-- **Possible values**: `2015`, `2018`
-- **Stable**: No
+#### `false` (default):
-### Example
+```rust
+impl<T> Lorem for T
+where
+ Option<T>: Ipsum,
+{
+ // body
+}
+```
-If you want to format code that requires edition 2018, add the following to your config file:
+#### `true`:
-```toml
-edition = "2018"
+```rust
+impl<T> Lorem for T
+where Option<T>: Ipsum
+{
+ // body
+}
```
-## `normalize_doc_attributes`
+See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
-Convert `#![doc]` and `#[doc]` attributes to `//!` and `///` doc comments.
+
+## `wrap_comments`
+
+Break comments to fit on the line
- **Default value**: `false`
- **Possible values**: `true`, `false`
-- **Stable**: No
+- **Stable**: No (tracking issue: [#3347](https://github.com/rust-lang/rustfmt/issues/3347))
#### `false` (default):
```rust
-#![doc = "Example documentation"]
+// 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.
-#[doc = "Example item documentation"]
-pub enum Foo {}
+// 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
-//! Example documentation
-
-/// Example item documentation
-pub enum Foo {}
+// 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