A possible content of `rustfmt.toml` or `.rustfmt.toml` might look like this:
```toml
-array_layout = "Block"
-array_width = 80
+indent_style = "Block"
reorder_imported_names = true
```
+Each configuration option is either stable or unstable.
+Stable options can be used directly, while unstable options are opt-in.
+To enable unstable options, set `unstable_features = true` in `rustfmt.toml` or pass `--unstable-options` to rustfmt.
+
# Configuration Options
Below you find a detailed visual guide on all the supported configuration options of rustfmt:
-## `array_horizontal_layout_threshold`
-How many elements array must have before rustfmt uses horizontal layout.
-Use this option to prevent a huge array from being vertically formatted.
+## `indent_style`
-- **Default value**: `0`
-- **Possible values**: any positive integer
+Indent on expressions or items.
-**Note:** A value of `0` results in [`array_layout`](#array_layout) being applied regardless of a line's width.
+- **Default value**: `"Block"`
+- **Possible values**: `"Block"`, `"Visual"`
+- **Stable**: No
-#### `0` (default):
+### Array
+
+#### `"Block"` (default):
```rust
-// Each element will be placed on its own line.
-let a = vec![
- 0,
- 1,
- 2,
- 3,
- 4,
- ...
- 999,
- 1000,
+let lorem = vec![
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit",
];
```
-#### `1000`:
+#### `"Visual"`:
```rust
-// Each element will be placed on the same line as much as possible.
-let a = vec![
- 0, 1, 2, 3, 4, ...
- ..., 999, 1000,
-];
+let lorem = vec!["ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit"];
```
-## `array_layout`
+### Control flow
-Indent on arrays
+#### `"Block"` (default):
-- **Default value**: `"Block"`
-- **Possible values**: `"Block"`, `"Visual"`
+```rust
+if lorem_ipsum &&
+ dolor_sit &&
+ amet_consectetur
+{
+ // ...
+}
+```
+
+#### `"Visual"`:
+
+```rust
+if lorem_ipsum &&
+ dolor_sit &&
+ amet_consectetur {
+ // ...
+}
+```
+
+See also: [`control_brace_style`](#control_brace_style).
+
+### Function arguments
#### `"Block"` (default):
```rust
-let lorem = vec![
+fn lorem() {}
+
+fn lorem(ipsum: usize) {}
+
+fn lorem(
+ ipsum: usize,
+ dolor: usize,
+ sit: usize,
+ amet: usize,
+ consectetur: usize,
+ adipiscing: usize,
+ elit: usize,
+) {
+ // body
+}
+```
+
+#### `"Visual"`:
+
+```rust
+fn lorem() {}
+
+fn lorem(ipsum: usize) {}
+
+fn lorem(ipsum: usize,
+ dolor: usize,
+ sit: usize,
+ amet: usize,
+ consectetur: usize,
+ adipiscing: usize,
+ elit: usize) {
+ // body
+}
+```
+
+### Function calls
+
+#### `"Block"` (default):
+
+```rust
+lorem(
+ "lorem",
"ipsum",
"dolor",
"sit",
"consectetur",
"adipiscing",
"elit",
-];
+);
```
#### `"Visual"`:
```rust
-let lorem = vec!["ipsum",
- "dolor",
- "sit",
- "amet",
- "consectetur",
- "adipiscing",
- "elit"];
+lorem("lorem",
+ "ipsum",
+ "dolor",
+ "sit",
+ "amet",
+ "consectetur",
+ "adipiscing",
+ "elit");
```
-## `array_width`
+### Generics
-Maximum width of an array literal before falling back to vertical formatting
+#### `"Block"` (default):
-- **Default value**: `60`
-- **Possible values**: any positive integer
+```rust
+fn lorem<
+ Ipsum: Eq = usize,
+ Dolor: Eq = usize,
+ Sit: Eq = usize,
+ Amet: Eq = usize,
+ Adipiscing: Eq = usize,
+ Consectetur: Eq = usize,
+ Elit: Eq = usize
+>(
+ ipsum: Ipsum,
+ dolor: Dolor,
+ sit: Sit,
+ amet: Amet,
+ adipiscing: Adipiscing,
+ consectetur: Consectetur,
+ elit: Elit,
+) -> T {
+ // body
+}
+```
+
+#### `"Visual"`:
+
+```rust
+fn lorem<Ipsum: Eq = usize,
+ Dolor: Eq = usize,
+ Sit: Eq = usize,
+ Amet: Eq = usize,
+ Adipiscing: Eq = usize,
+ Consectetur: Eq = usize,
+ Elit: Eq = usize>
+ (ipsum: Ipsum,
+ dolor: Dolor,
+ sit: Sit,
+ amet: Amet,
+ adipiscing: Adipiscing,
+ consectetur: Consectetur,
+ elit: Elit)
+ -> T {
+ // body
+}
+```
+
+#### Struct
+
+#### `"Block"` (default):
+
+```rust
+let lorem = Lorem {
+ ipsum: dolor,
+ sit: amet,
+};
+```
+
+#### `"Visual"`:
-**Note:** A value of `0` results in [`array_layout`](#array_layout) being applied regardless of a line's width.
+```rust
+let lorem = Lorem { ipsum: dolor,
+ sit: amet, };
+```
+
+See also: [`struct_lit_single_line`](#struct_lit_single_line), [`indent_style`](#indent_style).
+
+### Where predicates
+
+#### `"Block"` (default):
-#### Lines shorter than `array_width`:
```rust
-let lorem = vec!["ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing", "elit"];
+fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
+where
+ Ipsum: Eq,
+ Dolor: Eq,
+ Sit: Eq,
+ Amet: Eq
+{
+ // body
+}
```
-#### Lines longer than `array_width`:
-See [`array_layout`](#array_layout).
+#### `"Visual"`:
+
+```rust
+fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
+ where Ipsum: Eq,
+ Dolor: Eq,
+ Sit: Eq,
+ Amet: Eq
+{
+ // body
+}
+```
-## `attributes_on_same_line_as_field`
-Try to put attributes on the same line as fields
+## `same_line_attributes`
+
+Try to put attributes on the same line as fields and variants
- **Default value**: `true`
- **Possible values**: `true`, `false`
+- **Stable**: No
#### `true` (default):
#[serde(rename = "Dolor")] dolor: usize,
#[serde(rename = "Amet")] amet: usize,
}
+
+enum Lorem {
+ #[serde(skip_serializing)] Ipsum,
+ #[serde(skip_serializing)] Dolor,
+ #[serde(skip_serializing)] Amet,
+}
```
#### `false`:
#[serde(rename = "Amet")]
amet: usize,
}
+
+enum Lorem {
+ #[serde(skip_serializing)]
+ Ipsum,
+ #[serde(skip_serializing)]
+ Dolor,
+ #[serde(skip_serializing)]
+ Amet,
+}
```
-## `attributes_on_same_line_as_variant`
+## `use_small_heuristics`
-Try to put attributes on the same line as variants
+Whether to use different formatting for items and expressions if they satisfy a heuristic notion of 'small'.
- **Default value**: `true`
- **Possible values**: `true`, `false`
+- **Stable**: No
#### `true` (default):
```rust
enum Lorem {
- #[serde(skip_serializing)] Ipsum,
- #[serde(skip_serializing)] Dolor,
- #[serde(skip_serializing)] Amet,
+ 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 };
}
```
```rust
enum Lorem {
- #[serde(skip_serializing)]
Ipsum,
- #[serde(skip_serializing)]
- Dolor,
- #[serde(skip_serializing)]
- Amet,
+ 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
+ };
}
```
- **Default value**: `"Front"`
- **Possible values**: `"Front"`, `"Back"`
+- **Stable**: No
#### `"Front"` (default):
bbbbbbbbbbbbbbbbbbbbbbbbbbbbb;
```
-## `chain_indent`
-
-Indentation of chain
-
-- **Default value**: `"Block"`
-- **Possible values**: `"Block"`, `"Visual"`
-
-#### `"Block"` (default):
-
-```rust
-let lorem = ipsum
- .dolor()
- .sit()
- .amet()
- .consectetur()
- .adipiscing()
- .elit();
-```
-
-#### `"Visual"`:
-
-```rust
-let lorem = ipsum.dolor()
- .sit()
- .amet()
- .consectetur()
- .adipiscing()
- .elit();
-```
-
-See also [`chain_one_line_max`](#chain_one_line_max).
-
-## `chain_one_line_max`
-
-Maximum length of a chain to fit on a single line
-
-- **Default value**: `60`
-- **Possible values**: any positive integer
-
-#### Lines shorter than `chain_one_line_max`:
-```rust
-let lorem = ipsum.dolor().sit().amet().consectetur().adipiscing().elit();
-```
-
-#### Lines longer than `chain_one_line_max`:
-See [`chain_indent`](#chain_indent).
-
-## `chain_split_single_child`
-
-Split a chain with a single child if its length exceeds [`chain_one_line_max`](#chain_one_line_max).
-
-- **Default value**: `false`
-- **Possible values**: `false`, `true`
-
-#### `false` (default):
-
-```rust
-let files = fs::read_dir("tests/coverage/source").expect("Couldn't read source dir");
-```
-
-#### `true`:
-
-```rust
-let files = fs::read_dir("tests/coverage/source")
- .expect("Couldn't read source dir");
-```
-
-See also [`chain_one_line_max`](#chain_one_line_max).
-
-## `closure_block_indent_threshold`
-
-How many lines a closure must have before it is block indented. -1 means never use block indent.
-
-- **Default value**: `7`
-- **Possible values**: `-1`, or any positive integer
-
-#### Closures shorter than `closure_block_indent_threshold`:
-```rust
-lorem_ipsum(|| {
- println!("lorem");
- println!("ipsum");
- println!("dolor");
- println!("sit");
- println!("amet");
- });
-```
-
-#### Closures longer than `closure_block_indent_threshold`:
-```rust
-lorem_ipsum(|| {
- println!("lorem");
- println!("ipsum");
- println!("dolor");
- println!("sit");
- println!("amet");
- println!("consectetur");
- println!("adipiscing");
- println!("elit");
-});
-```
-
-**Note**: This option only takes effect when `fn_call_style` is set to `"Visual"`.
-
## `combine_control_expr`
Combine control expressions with function calls.
- **Default value**: `true`
- **Possible values**: `true`, `false`
+- **Stable**: No
#### `true` (default):
#### `false`:
```rust
+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();
+ }
+ );
+}
```
## `comment_width`
- **Default value**: `80`
- **Possible values**: any positive integer
+- **Stable**: No
**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
#### `false` (default):
let (lorem, ipsum, ..) = (1, 2, 3, 4);
```
-## `control_style`
-
-Indent style for control flow statements
-
-- **Default value**: `"Rfc"`
-- **Possible values**: `"Rfc"`, `"Legacy"`
-
-#### `"Rfc"` (default):
-
-```rust
-if lorem_ipsum &&
- dolor_sit &&
- amet_consectetur
-{
- // ...
-}
-```
-
-#### `"Legacy"`:
-
-```rust
-if lorem_ipsum &&
- dolor_sit &&
- amet_consectetur {
- // ...
-}
-```
-
-See also: [`control_brace_style`](#control_brace_style).
-
## `control_brace_style`
Brace style for control flow constructs
- **Default value**: `"AlwaysSameLine"`
- **Possible values**: `"AlwaysNextLine"`, `"AlwaysSameLine"`, `"ClosingNextLine"`
+- **Stable**: No
#### `"AlwaysSameLine"` (default):
- **Default value**: `false`
- **Possible values**: `true`, `false`
+- **Stable**: No
## `error_on_line_overflow`
-Error if unable to get all lines within max_width
+Error if unable to get all lines within `max_width`
- **Default value**: `true`
- **Possible values**: `true`, `false`
+- **Stable**: No
See also [`max_width`](#max_width).
+## `error_on_line_overflow_comments`
+
+Error if unable to get all comment lines within `comment_width`.
+
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No
+
+See also [`comment_width`](#comment_width).
+
## `fn_args_density`
Argument density in functions
- **Default value**: `"Tall"`
-- **Possible values**: `"Compressed"`, `"CompressedIfEmpty"`, `"Tall"`, `"Vertical"`
+- **Possible values**: `"Compressed"`, `"Tall"`, `"Vertical"`
+- **Stable**: No
#### `"Tall"` (default):
dolor: Dolor,
sit: Sit,
amet: Amet,
- consectetur: onsectetur,
+ consectetur: Consectetur,
adipiscing: Adipiscing,
elit: Elit,
);
dolor: Dolor,
sit: Sit,
amet: Amet,
- consectetur: onsectetur,
+ consectetur: Consectetur,
adipiscing: Adipiscing,
elit: Elit,
) {
}
```
-#### `"CompressedIfEmpty"`:
-
-```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: onsectetur,
- adipiscing: Adipiscing,
- elit: Elit,
- ) {
- // body
- }
-}
-```
-
#### `"Vertical"`:
```rust
dolor: Dolor,
sit: Sit,
amet: Amet,
- consectetur: onsectetur,
+ consectetur: Consectetur,
adipiscing: Adipiscing,
elit: Elit);
dolor: Dolor,
sit: Sit,
amet: Amet,
- consectetur: onsectetur,
+ consectetur: Consectetur,
adipiscing: Adipiscing,
elit: Elit) {
// body
}
```
-## `fn_args_layout`
-
-Layout of function arguments and tuple structs
-
-- **Default value**: `"Block"`
-- **Possible values**: `"Block"`, `"Visual"`
-
-#### `"Block"` (default):
-
-```rust
-fn lorem() {}
-
-fn lorem(ipsum: usize) {}
-
-fn lorem(
- ipsum: usize,
- dolor: usize,
- sit: usize,
- amet: usize,
- consectetur: usize,
- adipiscing: usize,
- elit: usize,
-) {
- // body
-}
-```
-
-#### `"Visual"`:
-
-```rust
-fn lorem() {}
-
-fn lorem(ipsum: usize) {}
-
-fn lorem(ipsum: usize,
- dolor: usize,
- sit: usize,
- amet: usize,
- consectetur: usize,
- adipiscing: usize,
- elit: usize) {
- // body
-}
-```
-
-## `fn_args_paren_newline`
-If function argument parenthesis goes on a newline
+## `brace_style`
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-
-#### `false` (default):
-
-```rust
-fn lorem(
- ipsum: Ipsum,
- dolor: Dolor,
- sit: Sit,
- amet: Amet,
-) -> DolorSitAmetConsecteturAdipiscingElitLoremIpsumDolorSitAmetConsecteturAdipiscingElit {
- // body
-}
-```
-
-#### `true`:
-
-```rust
-fn lorem
- (
- ipsum: Ipsum,
- dolor: Dolor,
- sit: Sit,
- amet: Amet,
-) -> DolorSitAmetConsecteturAdipiscingElitLoremIpsumDolorSitAmetConsecteturAdipiscingElit {
- // body
-}
-```
-
-## `fn_brace_style`
-
-Brace style for functions
+Brace style for items
- **Default value**: `"SameLineWhere"`
- **Possible values**: `"AlwaysNextLine"`, `"PreferSameLine"`, `"SameLineWhere"`
+- **Stable**: No
+
+### Functions
#### `"SameLineWhere"` (default):
}
```
-## `fn_call_style`
-
-Indentation for function calls, etc.
-
-- **Default value**: `"Block"`
-- **Possible values**: `"Block"`, `"Visual"`
+### Structs and enums
-#### `"Block"` (default):
+#### `"SameLineWhere"` (default):
```rust
-lorem(
- "lorem",
- "ipsum",
- "dolor",
- "sit",
- "amet",
- "consectetur",
- "adipiscing",
- "elit",
-);
-```
-
-#### `"Visual"`:
+struct Lorem {
+ ipsum: bool,
+}
-```rust
-lorem("lorem",
- "ipsum",
- "dolor",
- "sit",
- "amet",
- "consectetur",
- "adipiscing",
- "elit");
+struct Dolor<T>
+ where T: Eq
+{
+ sit: T,
+}
```
-## `fn_call_width`
+#### `"AlwaysNextLine"`:
-Maximum width of the args of a function call before falling back to vertical formatting
+```rust
+struct Lorem
+{
+ ipsum: bool,
+}
-- **Default value**: `60`
-- **Possible values**: any positive integer
+struct Dolor<T>
+ where T: Eq
+{
+ sit: T,
+}
+```
-**Note:** A value of `0` results in vertical formatting being applied regardless of a line's width.
+#### `"PreferSameLine"`:
-#### Function call shorter than `fn_call_width`:
```rust
-lorem("lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing", "elit");
-```
+struct Lorem {
+ ipsum: bool,
+}
-#### Function call longer than `fn_call_width`:
+struct Dolor<T>
+ where T: Eq {
+ sit: T,
+}
+```
-See [`fn_call_style`](#fn_call_style).
-## `fn_empty_single_line`
+## `empty_item_single_line`
-Put empty-body functions on a single line
+Put empty-body functions and impls on a single line
- **Default value**: `true`
- **Possible values**: `true`, `false`
+- **Stable**: No
#### `true` (default):
```rust
fn lorem() {}
+
+impl Lorem {}
```
#### `false`:
```rust
fn lorem() {
}
-```
-
-See also [`control_brace_style`](#control_brace_style).
-
-## `fn_return_indent`
-
-Location of return type in function declaration
-- **Default value**: `"WithArgs"`
-- **Possible values**: `"WithArgs"`, `"WithWhereClause"`
-
-#### `"WithArgs"` (default):
-
-```rust
-fn lorem(ipsum: Ipsum,
- dolor: Dolor,
- sit: Sit,
- amet: Amet,
- consectetur: Consectetur,
- adipiscing: Adipiscing)
- -> Elit
- where Ipsum: Eq
-{
- // body
+impl Lorem {
}
-
```
-#### `"WithWhereClause"`:
-
-```rust
-fn lorem(ipsum: Ipsum,
- dolor: Dolor,
- sit: Sit,
- amet: Amet,
- consectetur: Consectetur,
- adipiscing: Adipiscing)
- -> Elit
- where Ipsum: Eq
-{
- // body
-}
+See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
-```
-
-**Note**: This option only takes effect when `fn_call_style` is set to `"Visual"`.
## `fn_single_line`
- **Default value**: `false`
- **Possible values**: `true`, `false`
+- **Stable**: No
#### `false` (default):
See also [`control_brace_style`](#control_brace_style).
+
+## `where_single_line`
+
+To force single line where layout
+
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No
+
+#### `false` (default):
+
+```rust
+impl<T> Lorem for T
+where
+ Option<T>: Ipsum,
+{
+ ...
+}
+```
+
+#### `true`:
+
+```rust
+impl<T> Lorem for T
+where Option<T>: Ipsum {
+ ...
+}
+```
+
+See also [`brace_style`](#brace_style), [`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.
}
```
-## `force_format_strings`
-
-Always format string literals
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-
-See [`format_strings`](#format_strings).
-
-See also [`max_width`](#max_width).
-
## `format_strings`
Format string literals where necessary
- **Default value**: `false`
- **Possible values**: `true`, `false`
+- **Stable**: No
#### `false` (default):
adipiscing elit lorem ipsum dolor sit";
```
-See also [`force_format_strings`](#force_format_strings), [`max_width`](#max_width).
-
-## `generics_indent`
-
-Indentation of generics
-
-- **Default value**: `"Block"`
-- **Possible values**: `"Block"`, `"Visual"`
-
-#### `"Block"` (default):
-
-```rust
-fn lorem<
- Ipsum: Eq = usize,
- Dolor: Eq = usize,
- Sit: Eq = usize,
- Amet: Eq = usize,
- Adipiscing: Eq = usize,
- Consectetur: Eq = usize,
- Elit: Eq = usize
->(
- ipsum: Ipsum,
- dolor: Dolor,
- sit: Sit,
- amet: Amet,
- adipiscing: Adipiscing,
- consectetur: Consectetur,
- elit: Elit,
-) -> T {
- // body
-}
-```
-
-#### `"Visual"`:
-
-```rust
-fn lorem<Ipsum: Eq = usize,
- Dolor: Eq = usize,
- Sit: Eq = usize,
- Amet: Eq = usize,
- Adipiscing: Eq = usize,
- Consectetur: Eq = usize,
- Elit: Eq = usize>
- (ipsum: Ipsum,
- dolor: Dolor,
- sit: Sit,
- amet: Amet,
- adipiscing: Adipiscing,
- consectetur: Consectetur,
- elit: Elit)
- -> T {
- // body
-}
-```
+See also [`max_width`](#max_width).
## `hard_tabs`
- **Default value**: `false`
- **Possible values**: `true`, `false`
+- **Stable**: Yes
#### `false` (default):
See also: [`tab_spaces`](#tab_spaces).
-## `impl_empty_single_line`
-
-Put empty-body implementations on a single line
-
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-
-#### `true` (default):
-
-```rust
-impl Lorem {}
-```
-
-#### `false`:
-
-```rust
-impl Lorem {
-}
-```
-
-See also [`item_brace_style`](#item_brace_style).
-
-## `indent_match_arms`
-
-Indent match arms instead of keeping them at the same indentation level as the match keyword
-
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-
-#### `true` (default):
-
-```rust
-match lorem {
- Lorem::Ipsum => (),
- Lorem::Dolor => (),
- Lorem::Sit => (),
- Lorem::Amet => (),
-}
-```
-
-#### `false`:
-
-```rust
-match lorem {
-Lorem::Ipsum => (),
-Lorem::Dolor => (),
-Lorem::Sit => (),
-Lorem::Amet => (),
-}
-```
-
-See also: [`match_block_trailing_comma`](#match_block_trailing_comma), [`wrap_match_arms`](#wrap_match_arms).
## `imports_indent`
- **Default Value**: `"Visual"`
- **Possible values**: `"Block"`, `"Visual"`
+- **Stable**: No
#### `"Visual"` (default):
- **Default value**: "Mixed"
- **Possible values**: "Horizontal", "HorizontalVertical", "Mixed", "Vertical"
+- **Stable**: No
#### `"Mixed"` (default):
use foo::{aaa, bbb, ccc, ddd, eee, fff};
```
-#### `"HorizontalVertical"`
+#### `"HorizontalVertical"`:
```rust
use foo::{xxx, yyy, zzz};
fff};
```
-#### `"Vertical"`
-
-```rust
-use foo::{xxx,
- yyy,
- zzz};
-
-use foo::{aaa,
- bbb,
- ccc,
- ddd,
- eee,
- fff};
-```
-
-## `item_brace_style`
-
-Brace style for structs and enums
-
-- **Default value**: `"SameLineWhere"`
-- **Possible values**: `"AlwaysNextLine"`, `"PreferSameLine"`, `"SameLineWhere"`
-
-#### `"SameLineWhere"` (default):
-
-```rust
-struct Lorem {
- ipsum: bool,
-}
-
-struct Dolor<T>
- where T: Eq
-{
- sit: T,
-}
-```
-
-#### `"AlwaysNextLine"`:
-
-```rust
-struct Lorem
-{
- ipsum: bool,
-}
-
-struct Dolor<T>
- where T: Eq
-{
- sit: T,
-}
-```
-
-#### `"PreferSameLine"`:
-
-```rust
-struct Lorem {
- ipsum: bool,
-}
+#### `"Vertical"`:
-struct Dolor<T>
- where T: Eq {
- sit: T,
-}
+```rust
+use foo::{xxx,
+ yyy,
+ zzz};
+
+use foo::{aaa,
+ bbb,
+ ccc,
+ ddd,
+ eee,
+ fff};
```
+
## `match_block_trailing_comma`
Put a trailing comma after a block based match arm (non-block arms are not affected)
- **Default value**: `false`
- **Possible values**: `true`, `false`
+- **Stable**: No
#### `false` (default):
}
```
-See also: [`indent_match_arms`](#indent_match_arms), [`trailing_comma`](#trailing_comma), [`wrap_match_arms`](#wrap_match_arms).
-
-## `match_pattern_separator_break_point`
-
-Put a match sub-patterns' separator (`|`) in front or back.
-
-- **Default value**: `"Back"`
-- **Possible values**: `"Back"`, `"Front"`
-
-#### `"Back"` (default):
-
-```rust
-match m {
- Variant::Tag |
- Variant::Tag2 |
- Variant::Tag3 |
- Variant::Tag4 |
- Variant::Tag5 |
- Variant::Tag6 => {}
-}
-```
-
-#### `Front`:
-
-```rust
-match m {
- Variant::Tag
- | Variant::Tag2
- | Variant::Tag3
- | Variant::Tag4
- | Variant::Tag5
- | Variant::Tag6 => {}
-}
-```
+See also: [`trailing_comma`](#trailing_comma), [`match_arm_blocks`](#match_arm_blocks).
## `max_width`
- **Default value**: `100`
- **Possible values**: any positive integer
+- **Stable**: Yes
See also [`error_on_line_overflow`](#error_on_line_overflow).
- **Default value**: `true`
- **Possible values**: `true`, `false`
+- **Stable**: Yes
#### `true` (default):
pub enum Foo {}
```
-## `multiline_closure_forces_block`
+## `force_multiline_blocks`
-Force multiline closure bodies to be wrapped in a block
+Force multiline closure and match arm bodies to be wrapped in a block
- **Default value**: `false`
- **Possible values**: `false`, `true`
+- **Stable**: No
#### `false` (default):
None => ...,
Some(value) => ...,
})
+
+match lorem {
+ None => if ipsum {
+ println!("Hello World");
+ },
+ Some(dolor) => ...,
+}
```
#### `true`:
Some(value) => ...,
}
})
-```
-
-## `multiline_match_arm_forces_block`
-
-Force multiline match arm bodies to be wrapped in a block
-
-- **Default value**: `false`
-- **Possible values**: `false`, `true`
-
-#### `false` (default):
-
-```rust
-match lorem {
- None => if ipsum {
- println!("Hello World");
- },
- Some(dolor) => ...,
-}
-```
-
-#### `true`:
-```rust
match lorem {
None => {
if ipsum {
}
```
+
## `newline_style`
Unix or Windows line endings
- **Default value**: `"Unix"`
- **Possible values**: `"Native"`, `"Unix"`, `"Windows"`
+- **Stable**: Yes
## `normalize_comments`
- **Default value**: `false`
- **Possible values**: `true`, `false`
+- **Stable**: Yes
#### `false` (default):
- **Default value**: `false`
- **Possible values**: `true`, `false`
+- **Stable**: No
#### `false` (default):
- **Default value**: `false`
- **Possible values**: `true`, `false`
+- **Stable**: No
#### `false` (default):
- **Default value**: `false`
- **Possible values**: `true`, `false`
+- **Stable**: No
**Note:** This option takes effect only when [`reorder_imports`](#reorder_imports) is set to `true`.
See also [`reorder_imports`](#reorder_imports).
-## `single_line_if_else_max_width`
-
-Maximum line length for single line if-else expressions.
-
-- **Default value**: `50`
-- **Possible values**: any positive integer
-
-**Note:** A value of `0` results in if-else expressions being broken regardless of their line's width.
-
-#### Lines shorter than `single_line_if_else_max_width`:
-```rust
-let lorem = if ipsum { dolor } else { sit };
-```
-
-#### Lines longer than `single_line_if_else_max_width`:
-```rust
-let lorem = if ipsum {
- dolor
-} else {
- sit
-};
-```
-
-See also: [`control_brace_style`](#control_brace_style).
-
-## `skip_children`
-
-Don't reformat out of line modules
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
+## `reorder_extern_crates`
-## `space_after_bound_colon`
-
-Leave a space after the colon in a trait or lifetime bound
+Reorder `extern crate` statements alphabetically
- **Default value**: `true`
- **Possible values**: `true`, `false`
+- **Stable**: No
#### `true` (default):
```rust
-fn lorem<T: Eq>(t: T) {
- // body
-}
+extern crate dolor;
+extern crate ipsum;
+extern crate lorem;
+extern crate sit;
```
#### `false`:
```rust
-fn lorem<T:Eq>(t: T) {
- // body
-}
-```
-
-See also: [`space_before_bound`](#space_before_bound).
-
-## `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
-
-#### `0` (default):
-
-```rust
-struct Foo {
- x: u32,
- yy: u32,
- zzz: u32,
-}
+extern crate lorem;
+extern crate ipsum;
+extern crate dolor;
+extern crate sit;
```
-#### `20`:
-
-```rust
-struct Foo {
- x: u32,
- yy: u32,
- zzz: u32,
-}
-```
+See also [`reorder_extern_crates_in_group`](#reorder_extern_crates_in_group).
-## `space_after_struct_lit_field_colon`
+## `reorder_extern_crates_in_group`
-Leave a space after the colon in a struct literal field
+Reorder `extern crate` statements in group
- **Default value**: `true`
- **Possible values**: `true`, `false`
+- **Stable**: No
+
+**Note:** This option takes effect only when [`reorder_imports`](#reorder_imports) is set to `true`.
#### `true` (default):
```rust
-let lorem = Lorem {
- ipsum: dolor,
- sit: amet,
-};
+extern crate a;
+extern crate b;
+
+extern crate dolor;
+extern crate ipsum;
+extern crate lorem;
+extern crate sit;
```
#### `false`:
```rust
-let lorem = Lorem {
- ipsum:dolor,
- sit:amet,
-};
-```
-
-See also: [`space_before_struct_lit_field_colon`](#space_before_struct_lit_field_colon).
-
-## `space_after_type_annotation_colon`
-
-Leave a space after the colon in a type annotation
-
-- **Default value**: `true`
-- **Possible values**: `true`, `false`
-
-#### `true` (default):
+extern crate b;
+extern crate a;
-```rust
-fn lorem<T: Eq>(t: T) {
- let ipsum: Dolor = sit;
-}
+extern crate lorem;
+extern crate ipsum;
+extern crate dolor;
+extern crate sit;
```
-#### `false`:
+See also [`reorder_extern_crates`](#reorder_extern_crates).
-```rust
-fn lorem<T: Eq>(t:T) {
- let ipsum:Dolor = sit;
-}
-```
+## `report_todo`
-See also: [`space_before_type_annotation`](#space_before_type_annotation).
+Report `TODO` items in comments.
-## `space_before_bound`
+- **Default value**: `"Never"`
+- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
+- **Stable**: No
-Leave a space before the colon in a trait or lifetime bound
+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.
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
+See also [`report_fixme`](#report_fixme).
-#### `false` (default):
+## `report_fixme`
-```rust
-fn lorem<T: Eq>(t: T) {
- let ipsum: Dolor = sit;
-}
-```
+Report `FIXME` items in comments.
-#### `true`:
+- **Default value**: `"Never"`
+- **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
+- **Stable**: No
-```rust
-fn lorem<T : Eq>(t: T) {
- let ipsum: Dolor = sit;
-}
-```
+Warns about any comments containing `FIXME` in them when set to `"Always"`. If
+it contains a `#X` (with `X` being a number) in parentheses following the
+`FIXME`, `"Unnumbered"` will ignore it.
+
+See also [`report_todo`](#report_todo).
-See also: [`space_after_bound_colon`](#space_after_bound_colon).
-## `space_before_struct_lit_field_colon`
+## `skip_children`
-Leave a space before the colon in a struct literal field
+Don't reformat out of line modules
- **Default value**: `false`
- **Possible values**: `true`, `false`
+- **Stable**: No
-#### `false` (default):
-
-```rust
-let lorem = Lorem {
- ipsum: dolor,
- sit: amet,
-};
-```
-
-#### `true`:
-
-```rust
-let lorem = Lorem {
- ipsum : dolor,
- sit : amet,
-};
-```
-
-See also: [`space_after_struct_lit_field_colon`](#space_after_struct_lit_field_colon).
+## `space_after_colon`
-## `space_before_type_annotation`
+Leave a space after the colon.
-Leave a space before the colon in a type annotation
-
-- **Default value**: `false`
+- **Default value**: `true`
- **Possible values**: `true`, `false`
+- **Stable**: No
-#### `false` (default):
+#### `true` (default):
```rust
fn lorem<T: Eq>(t: T) {
- let ipsum: Dolor = sit;
+ let lorem: Dolor = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
}
```
-#### `true`:
+#### `false`:
```rust
-fn lorem<T: Eq>(t : T) {
- let ipsum : Dolor = sit;
+fn lorem<T:Eq>(t:T) {
+ let lorem:Dolor = Lorem {
+ ipsum:dolor,
+ sit:amet,
+ };
}
```
-See also: [`space_after_type_annotation_colon`](#space_after_type_annotation_colon).
-
-## `spaces_around_ranges`
-
-Put spaces around the .. and ... range operators
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-
-#### `false` (default):
-
-```rust
-let lorem = 0..10;
-```
-
-#### `true`:
-
-```rust
-let lorem = 0 .. 10;
-```
+See also: [`space_before_colon`](#space_before_colon).
-## `spaces_within_angle_brackets`
+## `space_before_colon`
-Put spaces within non-empty generic arguments
+Leave a space before the colon.
- **Default value**: `false`
- **Possible values**: `true`, `false`
+- **Stable**: No
#### `false` (default):
```rust
fn lorem<T: Eq>(t: T) {
- // body
+ let lorem: Dolor = Lorem {
+ ipsum: dolor,
+ sit: amet,
+ };
}
```
#### `true`:
```rust
-fn lorem< T: Eq >(t: T) {
- // body
+fn lorem<T : Eq>(t : T) {
+ let lorem : Dolor = Lorem {
+ ipsum : dolor,
+ sit : amet,
+ };
}
```
-See also: [`spaces_within_parens`](#spaces_within_parens), [`spaces_within_square_brackets`](#spaces_within_square_brackets).
+See also: [`space_after_colon`](#space_after_colon).
-## `spaces_within_parens`
+## `struct_field_align_threshold`
-Put spaces within non-empty parentheses
+The maximum diff of width between struct fields to be aligned with each other.
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
+- **Default value** : 0
+- **Possible values**: any positive integer
+- **Stable**: No
-#### `false` (default):
+#### `0` (default):
```rust
-fn lorem<T: Eq>(t: T) {
- let lorem = (ipsum, dolor);
+struct Foo {
+ x: u32,
+ yy: u32,
+ zzz: u32,
}
```
-#### `true`:
+#### `20`:
```rust
-fn lorem<T: Eq>( t: T ) {
- let lorem = ( ipsum, dolor );
+struct Foo {
+ x: u32,
+ yy: u32,
+ zzz: u32,
}
```
-See also: [`spaces_within_angle_brackets`](#spaces_within_angle_brackets), [`spaces_within_square_brackets`](#spaces_within_square_brackets).
-
-## `spaces_within_square_brackets`
+## `spaces_around_ranges`
-Put spaces within non-empty square brackets
+Put spaces around the .. and ... range operators
- **Default value**: `false`
- **Possible values**: `true`, `false`
+- **Stable**: No
-#### `false` (default):
-
-```rust
-let lorem: [usize; 2] = [ipsum, dolor];
-```
-
-#### `true`:
-
-```rust
-let lorem: [ usize; 2 ] = [ ipsum, dolor ];
-```
-
-See also: [`spaces_within_parens`](#spaces_within_parens), [`spaces_within_angle_brackets`](#spaces_within_angle_brackets).
-
-## `struct_lit_multiline_style`
-
-Multiline style on literal structs
-
-- **Default value**: `"PreferSingle"`
-- **Possible values**: `"ForceMulti"`, `"PreferSingle"`
-
-#### `"PreferSingle"` (default):
-
-```rust
-let lorem = Lorem { ipsum: dolor, sit: amet };
-```
-
-#### `"ForceMulti"`:
-
-```rust
-let lorem = Lorem {
- ipsum: dolor,
- sit: amet,
-};
-```
-
-See also: [`struct_lit_style`](#struct_lit_style), [`struct_lit_width`](#struct_lit_width).
-
-## `struct_lit_style`
-
-Style of struct definition
-
-- **Default value**: `"Block"`
-- **Possible values**: `"Block"`, `"Visual"`
-
-#### `"Block"` (default):
+#### `false` (default):
```rust
-let lorem = Lorem {
- ipsum: dolor,
- sit: amet,
-};
+let lorem = 0..10;
```
-#### `"Visual"`:
+#### `true`:
```rust
-let lorem = Lorem { ipsum: dolor,
- sit: amet, };
+let lorem = 0 .. 10;
```
-See also: [`struct_lit_multiline_style`](#struct_lit_multiline_style), [`struct_lit_style`](#struct_lit_style).
-
-## `struct_lit_width`
+## `spaces_within_parens_and_brackets`
-Maximum width in the body of a struct lit before falling back to vertical formatting
+Put spaces within non-empty generic arguments, parentheses, and square brackets
-- **Default value**: `18`
-- **Possible values**: any positive integer
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: No
-**Note:** A value of `0` results in vertical formatting being applied regardless of a line's width.
+#### `false` (default):
-#### Lines shorter than `struct_lit_width`:
```rust
-let lorem = Lorem { ipsum: dolor, sit: amet };
+// generic arguments
+fn lorem<T: Eq>(t: T) {
+ // body
+}
+
+// non-empty parentheses
+fn lorem<T: Eq>(t: T) {
+ let lorem = (ipsum, dolor);
+}
+
+// non-empty square brackets
+let lorem: [usize; 2] = [ipsum, dolor];
```
-#### Lines longer than `struct_lit_width`:
-See [`struct_lit_style`](#struct_lit_style).
+#### `true`:
+
+```rust
+// generic arguments
+fn lorem< T: Eq >(t: T) {
+ // body
+}
+
+// non-empty parentheses
+fn lorem<T: Eq>( t: T ) {
+ let lorem = ( ipsum, dolor );
+}
-See also: [`struct_lit_multiline_style`](#struct_lit_multiline_style), [`struct_lit_style`](#struct_lit_style).
+// non-empty square brackets
+let lorem: [ usize; 2 ] = [ ipsum, dolor ];
+```
-## `struct_variant_width`
+## `struct_lit_single_line`
-Maximum width in the body of a struct variant before falling back to vertical formatting
+Put small struct literals on a single line
-- **Default value**: `35`
-- **Possible values**: any positive integer
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No
-**Note:** A value of `0` results in vertical formatting being applied regardless of a line's width.
+#### `true` (default):
-#### Struct variants shorter than `struct_variant_width`:
```rust
-enum Lorem {
- Ipsum,
- Dolor(bool),
- Sit { amet: Consectetur, adipiscing: Elit },
-}
+let lorem = Lorem { ipsum: dolor, sit: amet };
```
-#### Struct variants longer than `struct_variant_width`:
+#### `false`:
+
```rust
-enum Lorem {
- Ipsum,
- Dolor(bool),
- Sit {
- amet: Consectetur,
- adipiscing: Elit,
- },
-}
+let lorem = Lorem {
+ ipsum: dolor,
+ sit: amet,
+};
```
+See also: [`indent_style`](#indent_style).
+
+
## `tab_spaces`
Number of spaces per tab
- **Default value**: `4`
- **Possible values**: any positive integer
+- **Stable**: Yes
#### `4` (default):
See also: [`hard_tabs`](#hard_tabs).
-## `take_source_hints`
-
-Retain some formatting characteristics from the source code
-
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
-
-#### `false` (default):
-
-```rust
-lorem
- .ipsum()
- .dolor(|| { sit.amet().consectetur().adipiscing().elit(); });
-```
-
-#### `true`:
-
-```rust
-lorem
- .ipsum()
- .dolor(|| {
- sit.amet()
- .consectetur()
- .adipiscing()
- .elit();
- });
-```
-
-Note: This only applies if the call chain within the inner closure had already been formatted on separate lines before running rustfmt.
## `trailing_comma`
- **Default value**: `"Vertical"`
- **Possible values**: `"Always"`, `"Never"`, `"Vertical"`
+- **Stable**: No
#### `"Vertical"` (default):
- **Default value**: `true`
- **Possible values**: `true`, `false`
+- **Stable**: No
#### `true` (default):
```rust
- **Default value**: `"Wide"`
- **Possible values**: `"Compressed"`, `"Wide"`
+- **Stable**: No
#### `"Wide"` (default):
- **Default value**: `false`
- **Possible values**: `true`, `false`
+- **Stable**: No
#### `false` (default):
let lorem = ipsum.map(|dolor| dolor.sit())?;
```
-## `where_density`
-Density of a where clause.
+## `wrap_comments`
+
+Break comments to fit on the line
-- **Default value**: `"CompressedIfEmpty"`
-- **Possible values**: `"Compressed"`, `"CompressedIfEmpty"`, `"Tall"`, `"Vertical"`
+- **Default value**: `false`
+- **Possible values**: `true`, `false`
+- **Stable**: Yes
-#### `"CompressedIfEmpty"` (default):
+#### `false` (default):
```rust
-trait Lorem {
- fn ipsum<Dolor>(dolor: Dolor) -> Sit
- where Dolor: Eq;
-
- fn ipsum<Dolor>(dolor: Dolor) -> Sit
- where
- Dolor: Eq,
- {
- // body
- }
-}
+// 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.
```
-#### `"Compressed"`:
+#### `true`:
```rust
-trait Lorem {
- fn ipsum<Dolor>(dolor: Dolor) -> Sit
- where Dolor: Eq;
-
- fn ipsum<Dolor>(dolor: Dolor) -> Sit
- where Dolor: Eq {
- // body
- }
-}
+// 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.
```
-#### `"Tall"`:
+## `match_arm_blocks`
-```rust
-trait Lorem {
- fn ipsum<Dolor>(dolor: Dolor) -> Sit
- where
- Dolor: Eq;
-
- fn ipsum<Dolor>(dolor: Dolor) -> Sit
- where
- Dolor: Eq,
- {
- // body
- }
-}
-```
+Wrap the body of arms in blocks when it does not fit on the same line with the pattern of arms
-**Note:** `where_density = "Tall"` currently produces the same output as `where_density = "Vertical"`.
+- **Default value**: `true`
+- **Possible values**: `true`, `false`
+- **Stable**: No
-#### `"Vertical"`:
+#### `true` (default):
```rust
-trait Lorem {
- fn ipsum<Dolor>(dolor: Dolor) -> Sit
- where Dolor: Eq;
-
- fn ipsum<Dolor>(dolor: Dolor) -> Sit
- where Dolor: Eq
- {
- // body
+match lorem {
+ true => {
+ foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x)
}
+ false => println!("{}", sit),
}
```
-**Note:** `where_density = "Vertical"` currently produces the same output as `where_density = "Tall"`.
-
-See also: [`where_layout`](#where_layout), [`where_pred_indent`](#where_pred_indent), [`where_style`](#where_style).
-
-## `where_layout`
-
-Element layout inside a where clause
-
-- **Default value**: `"Vertical"`
-- **Possible values**: `"Horizontal"`, `"HorizontalVertical"`, `"Mixed"`, `"Vertical"`
-
-#### `"Vertical"` (default):
+#### `false`:
```rust
-fn lorem<Ipsum, Dolor>(ipsum: Ipsum, dolor: Dolor)
- where Ipsum: IpsumDolorSitAmet,
- Dolor: DolorSitAmetConsectetur
-{
- // body
-}
-
-fn lorem<Ipsum, Dolor, Sit, Amet>(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet)
- where Ipsum: IpsumDolorSitAmet,
- Dolor: DolorSitAmetConsectetur,
- Sit: SitAmetConsecteturAdipiscing,
- Amet: AmetConsecteturAdipiscingElit
-{
- // body
+match lorem {
+ true =>
+ foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x),
+ false => println!("{}", sit),
}
```
-#### `"Horizontal"`:
+See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
-```rust
-fn lorem<Ipsum, Dolor>(ipsum: Ipsum, dolor: Dolor)
- where Ipsum: IpsumDolorSitAmet, Dolor: DolorSitAmetConsectetur
-{
- // body
-}
+## `write_mode`
-fn lorem<Ipsum, Dolor, Sit, Amet>(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet)
- where Ipsum: IpsumDolorSitAmet, Dolor: DolorSitAmetConsectetur, Sit: SitAmetConsecteturAdipiscing, Amet: AmetConsecteturAdipiscingElit
-{
- // body
-}
-```
+What Write Mode to use when none is supplied: Replace, Overwrite, Display, Diff, Coverage
-#### `"HorizontalVertical"`:
+- **Default value**: `"Overwrite"`
+- **Possible values**: `"Checkstyle"`, `"Coverage"`, `"Diff"`, `"Display"`, `"Overwrite"`, `"Plain"`, `"Replace"`
+- **Stable**: No
-```rust
-fn lorem<Ipsum, Dolor>(ipsum: Ipsum, dolor: Dolor)
- where Ipsum: IpsumDolorSitAmet, Dolor: DolorSitAmetConsectetur
-{
- // body
-}
+## `blank_lines_upper_bound`
-fn lorem<Ipsum, Dolor, Sit, Amet>(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet)
- where Ipsum: IpsumDolorSitAmet,
- Dolor: DolorSitAmetConsectetur,
- Sit: SitAmetConsecteturAdipiscing,
- Amet: AmetConsecteturAdipiscingElit
-{
- // body
-}
-```
+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.
-#### `"Mixed"`:
+- **Default value**: `1`
+- **Possible values**: *unsigned integer*
+- **Stable**: No
-```rust
-fn lorem<Ipsum, Dolor>(ipsum: Ipsum, dolor: Dolor)
- where Ipsum: IpsumDolorSitAmet, Dolor: DolorSitAmetConsectetur
-{
- // body
-}
+### Example
+Original Code:
-fn lorem<Ipsum, Dolor, Sit, Amet>(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet)
- where Ipsum: IpsumDolorSitAmet, Dolor: DolorSitAmetConsectetur,
- Sit: SitAmetConsecteturAdipiscing, Amet: AmetConsecteturAdipiscingElit
-{
- // body
+```rust
+fn foo() {
+ println!("a");
}
-```
-
-**Note**: This option only takes effect when `where_style` is set to `"Legacy"`.
-
-See also: [`where_density`](#where_density), [`where_pred_indent`](#where_pred_indent), [`where_style`](#where_style).
-## `where_pred_indent`
-Indentation style of a where predicate
-- **Default value**: `"Visual"`
-- **Possible values**: `"Block"`, `"Visual"`
+fn bar() {
+ println!("b");
-#### `"Visual"` (default):
-```rust
-fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
- where Ipsum: Eq,
- Dolor: Eq,
- Sit: Eq,
- Amet: Eq
-{
- // body
+ println!("c");
}
```
-#### `"Block"`:
-
+#### `1` (default):
```rust
-fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
- where Ipsum: Eq,
- Dolor: Eq,
- Sit: Eq,
- Amet: Eq
-{
- // body
+fn foo() {
+ println!("a");
}
-```
-
-**Note**: This option only takes effect when `where_style` is set to `"Legacy"`.
-
-See also: [`where_density`](#where_density), [`where_layout`](#where_layout), [`where_style`](#where_style).
-
-## `where_style`
-Overall strategy for where clauses
+fn bar() {
+ println!("b");
-- **Default value**: `"Rfc"`
-- **Possible values**: `"Rfc"`, `"Legacy"`
-
-#### `"Rfc"` (default):
-
-```rust
-fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
-where
- Ipsum: Eq,
- Dolor: Eq,
- Sit: Eq,
- Amet: Eq,
-{
- // body
+ println!("c");
}
```
-#### `"Legacy"`:
-
+#### `2` (default):
```rust
-fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
- where Ipsum: Eq,
- Dolor: Eq,
- Sit: Eq,
- Amet: Eq
-{
- // body
+fn foo() {
+ println!("a");
}
-```
-
-See also: [`where_density`](#where_density), [`where_layout`](#where_layout), [`where_pred_indent`](#where_pred_indent).
-## `wrap_comments`
-
-Break comments to fit on the line
-- **Default value**: `false`
-- **Possible values**: `true`, `false`
+fn bar() {
+ println!("b");
-#### `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.
+ println!("c");
+}
```
-#### `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.
-```
+See also: [`blank_lines_lower_bound`](#blank_lines_lower_bound)
-## `wrap_match_arms`
+## `blank_lines_lower_bound`
-Wrap the body of arms in blocks when it does not fit on the same line with the pattern of arms
+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**: `true`
-- **Possible values**: `true`, `false`
+- **Default value**: `0`
+- **Possible values**: *unsigned integer*
+- **Stable**: No
-#### `true` (default):
+### Example
+Original Code (rustfmt will not change it with the default value of `0`):
```rust
-match lorem {
- true => {
- foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x)
- }
- false => println!("{}", sit),
+fn foo() {
+ println!("a");
+}
+fn bar() {
+ println!("b");
+ println!("c");
}
```
-#### `false`:
-
+#### `1`
```rust
-match lorem {
- true =>
- foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x),
- false => println!("{}", sit),
-}
-```
+fn foo() {
-See also: [`indent_match_arms`](#indent_match_arms), [`match_block_trailing_comma`](#match_block_trailing_comma).
+ println!("a");
+}
-## `write_mode`
+fn bar() {
-What Write Mode to use when none is supplied: Replace, Overwrite, Display, Diff, Coverage
+ println!("b");
-- **Default value**: `"Overwrite"`
-- **Possible values**: `"Checkstyle"`, `"Coverage"`, `"Diff"`, `"Display"`, `"Overwrite"`, `"Plain"`, `"Replace"`
+ println!("c");
+}
+```
projects / rust.git / blobdiff