3 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.
5 A possible content of `rustfmt.toml` or `.rustfmt.toml` might look like this:
9 reorder_imported_names = true
12 Each configuration option is either stable or unstable.
13 Stable options can be used directly, while unstable options are opt-in.
14 To enable unstable options, set `unstable_features = true` in `rustfmt.toml` or pass `--unstable-options` to rustfmt.
16 # Configuration Options
18 Below you find a detailed visual guide on all the supported configuration options of rustfmt:
23 Indent on expressions or items.
25 - **Default value**: `"Block"`
26 - **Possible values**: `"Block"`, `"Visual"`
31 #### `"Block"` (default):
51 let lorem = vec!["ipsum",
63 #### `"Block"` (default):
84 See also: [`control_brace_style`](#control_brace_style).
86 ### Function arguments
88 #### `"Block"` (default):
93 fn lorem(ipsum: usize) {}
113 fn lorem(ipsum: usize) {}
115 fn lorem(ipsum: usize,
128 #### `"Block"` (default):
162 #### `"Block"` (default):
170 Adipiscing: Eq = usize,
171 Consectetur: Eq = usize,
178 adipiscing: Adipiscing,
179 consectetur: Consectetur,
189 fn lorem<Ipsum: Eq = usize,
193 Adipiscing: Eq = usize,
194 Consectetur: Eq = usize,
200 adipiscing: Adipiscing,
201 consectetur: Consectetur,
210 #### `"Block"` (default):
225 let lorem = Lorem { ipsum: dolor,
230 See also: [`struct_lit_single_line`](#struct_lit_single_line), [`indent_style`](#indent_style).
234 #### `"Block"` (default):
237 fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
251 fn lorem<Ipsum, Dolor, Sit, Amet>() -> T
261 ## `use_small_heuristics`
263 Whether to use different formatting for items and expressions if they satisfy a heuristic notion of 'small'.
265 - **Default value**: `true`
266 - **Possible values**: `true`, `false`
269 #### `true` (default):
275 Sit { amet: Consectetur, adipiscing: Elit },
293 let lorem = Lorem { ipsum: dolor };
295 let lorem = if ipsum { dolor } else { sit };
312 lorem("lorem", "ipsum", "dolor", "sit", "amet", "consectetur", "adipiscing");
319 let lorem = if ipsum {
329 Where to put a binary operator when a binary expression goes multiline.
331 - **Default value**: `"Front"`
332 - **Possible values**: `"Front"`, `"Back"`
335 #### `"Front"` (default):
339 let or = foofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoo
340 || barbarbarbarbarbarbarbarbarbarbarbarbarbarbarbar;
342 let sum = 123456789012345678901234567890 + 123456789012345678901234567890
343 + 123456789012345678901234567890;
345 let range = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
346 ..bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;
354 let or = foofoofoofoofoofoofoofoofoofoofoofoofoofoofoofoo ||
355 barbarbarbarbarbarbarbarbarbarbarbarbarbarbarbar;
357 let sum = 123456789012345678901234567890 + 123456789012345678901234567890 +
358 123456789012345678901234567890;
360 let range = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa..
361 bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;
365 ## `combine_control_expr`
367 Combine control expressions with function calls.
369 - **Default value**: `true`
370 - **Possible values**: `true`, `false`
373 #### `true` (default):
385 foo!(if let Some(..) = x {
398 foo!(while let Some(..) = x {
432 if let Some(..) = x {
449 while let Some(..) = x {
475 Maximum length of comments. No effect unless`wrap_comments = true`.
477 - **Default value**: `80`
478 - **Possible values**: any positive integer
481 **Note:** A value of `0` results in [`wrap_comments`](#wrap_comments) being applied regardless of a line's width.
483 #### `80` (default; comments shorter than `comment_width`):
485 // Lorem ipsum dolor sit amet, consectetur adipiscing elit.
488 #### `60` (comments longer than `comment_width`):
490 // Lorem ipsum dolor sit amet,
491 // consectetur adipiscing elit.
494 See also [`wrap_comments`](#wrap_comments).
496 ## `condense_wildcard_suffixes`
498 Replace strings of _ wildcards by a single .. in tuple patterns
500 - **Default value**: `false`
501 - **Possible values**: `true`, `false`
504 #### `false` (default):
508 let (lorem, ipsum, _, _) = (1, 2, 3, 4);
509 let (lorem, ipsum, ..) = (1, 2, 3, 4);
517 let (lorem, ipsum, ..) = (1, 2, 3, 4);
521 ## `control_brace_style`
523 Brace style for control flow constructs
525 - **Default value**: `"AlwaysSameLine"`
526 - **Possible values**: `"AlwaysNextLine"`, `"AlwaysSameLine"`, `"ClosingNextLine"`
529 #### `"AlwaysSameLine"` (default):
541 #### `"AlwaysNextLine"`:
556 #### `"ClosingNextLine"`:
569 ## `disable_all_formatting`
571 Don't reformat anything
573 - **Default value**: `false`
574 - **Possible values**: `true`, `false`
577 ## `error_on_line_overflow`
579 Error if unable to get all lines within `max_width`
581 - **Default value**: `true`
582 - **Possible values**: `true`, `false`
585 See also [`max_width`](#max_width).
587 ## `error_on_line_overflow_comments`
589 Error if unable to get all comment lines within `comment_width`.
591 - **Default value**: `true`
592 - **Possible values**: `true`, `false`
595 See also [`comment_width`](#comment_width).
599 Argument density in functions
601 - **Default value**: `"Tall"`
602 - **Possible values**: `"Compressed"`, `"Tall"`, `"Vertical"`
605 #### `"Tall"` (default):
609 fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet);
611 fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet) {
620 consectetur: Consectetur,
621 adipiscing: Adipiscing,
630 consectetur: Consectetur,
631 adipiscing: Adipiscing,
643 fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet);
645 fn lorem(ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet) {
650 ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet, consectetur: Consectetur,
651 adipiscing: Adipiscing, elit: Elit,
655 ipsum: Ipsum, dolor: Dolor, sit: Sit, amet: Amet, consectetur: Consectetur,
656 adipiscing: Adipiscing, elit: Elit,
688 consectetur: Consectetur,
689 adipiscing: Adipiscing,
698 consectetur: Consectetur,
699 adipiscing: Adipiscing,
710 Brace style for items
712 - **Default value**: `"SameLineWhere"`
713 - **Possible values**: `"AlwaysNextLine"`, `"PreferSameLine"`, `"SameLineWhere"`
718 #### `"SameLineWhere"` (default):
725 fn lorem(ipsum: usize) {
729 fn lorem<T>(ipsum: T)
731 T: Add + Sub + Mul + Div,
737 #### `"AlwaysNextLine"`:
745 fn lorem(ipsum: usize)
750 fn lorem<T>(ipsum: T)
752 T: Add + Sub + Mul + Div,
758 #### `"PreferSameLine"`:
765 fn lorem(ipsum: usize) {
769 fn lorem<T>(ipsum: T)
771 T: Add + Sub + Mul + Div, {
776 ### Structs and enums
778 #### `"SameLineWhere"` (default):
793 #### `"AlwaysNextLine"`:
809 #### `"PreferSameLine"`:
824 ## `empty_item_single_line`
826 Put empty-body functions and impls on a single line
828 - **Default value**: `true`
829 - **Possible values**: `true`, `false`
832 #### `true` (default):
850 See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
855 Put single-expression functions on a single line
857 - **Default value**: `false`
858 - **Possible values**: `true`, `false`
861 #### `false` (default):
864 fn lorem() -> usize {
868 fn lorem() -> usize {
877 fn lorem() -> usize { 42 }
879 fn lorem() -> usize {
885 See also [`control_brace_style`](#control_brace_style).
888 ## `where_single_line`
890 To force single line where layout
892 - **Default value**: `false`
893 - **Possible values**: `true`, `false`
896 #### `false` (default):
911 where Option<T>: Ipsum
917 See also [`brace_style`](#brace_style), [`control_brace_style`](#control_brace_style).
920 ## `force_explicit_abi`
922 Always print the abi for extern items
924 - **Default value**: `true`
925 - **Possible values**: `true`, `false`
928 **Note:** Non-"C" ABIs are always printed. If `false` then "C" is removed.
930 #### `true` (default):
934 pub static lorem: c_int;
942 pub static lorem: c_int;
948 Format string literals where necessary
950 - **Default value**: `false`
951 - **Possible values**: `true`, `false`
954 #### `false` (default):
959 "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet consectetur adipiscing";
967 let lorem = "ipsum dolor sit amet consectetur adipiscing elit lorem ipsum dolor sit amet \
968 consectetur adipiscing";
972 See also [`max_width`](#max_width).
976 Use tab characters for indentation, spaces for alignment
978 - **Default value**: `false`
979 - **Possible values**: `true`, `false`
982 #### `false` (default):
985 fn lorem() -> usize {
986 42 // spaces before 42
993 fn lorem() -> usize {
998 See also: [`tab_spaces`](#tab_spaces).
1003 Indent style of imports
1005 - **Default Value**: `"Visual"`
1006 - **Possible values**: `"Block"`, `"Visual"`
1009 #### `"Visual"` (default):
1012 use foo::{xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy,
1013 zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz};
1020 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy,
1021 zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
1025 See also: [`imports_layout`](#imports_layout).
1029 Item layout inside a imports block
1031 - **Default value**: "Mixed"
1032 - **Possible values**: "Horizontal", "HorizontalVertical", "Mixed", "Vertical"
1035 #### `"Mixed"` (default):
1038 use foo::{xxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyy, zzzzzzzzzzzzzzzzzz};
1040 use foo::{aaaaaaaaaaaaaaaaaa, bbbbbbbbbbbbbbbbbb, cccccccccccccccccc, dddddddddddddddddd,
1041 eeeeeeeeeeeeeeeeee, ffffffffffffffffff};
1044 #### `"Horizontal"`:
1046 **Note**: This option forces all imports onto one line and may exceed `max_width`.
1049 use foo::{xxx, yyy, zzz};
1051 use foo::{aaa, bbb, ccc, ddd, eee, fff};
1054 #### `"HorizontalVertical"`:
1057 use foo::{xxxxxxxxxxxxxxxxxx, yyyyyyyyyyyyyyyyyy, zzzzzzzzzzzzzzzzzz};
1059 use foo::{aaaaaaaaaaaaaaaaaa,
1064 ffffffffffffffffff};
1083 ## `match_block_trailing_comma`
1085 Put a trailing comma after a block based match arm (non-block arms are not affected)
1087 - **Default value**: `false`
1088 - **Possible values**: `true`, `false`
1091 #### `false` (default):
1099 Lorem::Dolor => println!("dolor"),
1111 Lorem::Dolor => println!("dolor"),
1115 See also: [`trailing_comma`](#trailing_comma), [`match_arm_blocks`](#match_arm_blocks).
1119 Maximum width of each line
1121 - **Default value**: `100`
1122 - **Possible values**: any positive integer
1125 See also [`error_on_line_overflow`](#error_on_line_overflow).
1129 Merge multiple derives into a single one.
1131 - **Default value**: `true`
1132 - **Possible values**: `true`, `false`
1135 #### `true` (default):
1138 #[derive(Eq, PartialEq, Debug, Copy, Clone)]
1145 #[derive(Eq, PartialEq)]
1147 #[derive(Copy, Clone)]
1151 ## `force_multiline_blocks`
1153 Force multiline closure and match arm bodies to be wrapped in a block
1155 - **Default value**: `false`
1156 - **Possible values**: `false`, `true`
1159 #### `false` (default):
1162 result.and_then(|maybe_value| match maybe_value {
1169 println!("Hello World");
1179 result.and_then(|maybe_value| {
1189 println!("Hello World");
1199 Unix or Windows line endings
1201 - **Default value**: `"Unix"`
1202 - **Possible values**: `"Native"`, `"Unix"`, `"Windows"`
1205 ## `normalize_comments`
1207 Convert /* */ comments to // comments where possible
1209 - **Default value**: `false`
1210 - **Possible values**: `true`, `false`
1213 #### `false` (default):
1217 fn dolor() -> usize {}
1220 fn adipiscing() -> usize {}
1227 fn dolor() -> usize {}
1230 fn adipiscing() -> usize {}
1233 ## `reorder_imported_names`
1235 Reorder lists of names in import statements alphabetically
1237 - **Default value**: `false`
1238 - **Possible values**: `true`, `false`
1241 #### `false` (default):
1244 use super::{lorem, ipsum, dolor, sit};
1250 use super::{dolor, ipsum, lorem, sit};
1253 See also [`reorder_imports`](#reorder_imports).
1255 ## `reorder_imports`
1257 Reorder import statements alphabetically
1259 - **Default value**: `false`
1260 - **Possible values**: `true`, `false`
1263 #### `false` (default):
1281 See also [`reorder_imported_names`](#reorder_imported_names), [`reorder_imports_in_group`](#reorder_imports_in_group).
1283 ## `reorder_imports_in_group`
1285 Reorder import statements in group
1287 - **Default value**: `false`
1288 - **Possible values**: `true`, `false`
1291 **Note:** This option takes effect only when [`reorder_imports`](#reorder_imports) is set to `true`.
1293 #### `false` (default):
1317 See also [`reorder_imports`](#reorder_imports).
1319 ## `reorder_extern_crates`
1321 Reorder `extern crate` statements alphabetically
1323 - **Default value**: `true`
1324 - **Possible values**: `true`, `false`
1327 #### `true` (default):
1345 See also [`reorder_extern_crates_in_group`](#reorder_extern_crates_in_group).
1347 ## `reorder_extern_crates_in_group`
1349 Reorder `extern crate` statements in group
1351 - **Default value**: `true`
1352 - **Possible values**: `true`, `false`
1355 **Note:** This option takes effect only when [`reorder_imports`](#reorder_imports) is set to `true`.
1357 #### `true` (default):
1381 See also [`reorder_extern_crates`](#reorder_extern_crates).
1385 Report `TODO` items in comments.
1387 - **Default value**: `"Never"`
1388 - **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
1391 Warns about any comments containing `TODO` in them when set to `"Always"`. If
1392 it contains a `#X` (with `X` being a number) in parentheses following the
1393 `TODO`, `"Unnumbered"` will ignore it.
1395 See also [`report_fixme`](#report_fixme).
1399 Report `FIXME` items in comments.
1401 - **Default value**: `"Never"`
1402 - **Possible values**: `"Always"`, `"Unnumbered"`, `"Never"`
1405 Warns about any comments containing `FIXME` in them when set to `"Always"`. If
1406 it contains a `#X` (with `X` being a number) in parentheses following the
1407 `FIXME`, `"Unnumbered"` will ignore it.
1409 See also [`report_todo`](#report_todo).
1414 Don't reformat out of line modules
1416 - **Default value**: `false`
1417 - **Possible values**: `true`, `false`
1420 ## `space_after_colon`
1422 Leave a space after the colon.
1424 - **Default value**: `true`
1425 - **Possible values**: `true`, `false`
1428 #### `true` (default):
1431 fn lorem<T: Eq>(t: T) {
1432 let lorem: Dolor = Lorem {
1442 fn lorem<T:Eq>(t:T) {
1443 let lorem:Dolor = Lorem {
1450 See also: [`space_before_colon`](#space_before_colon).
1452 ## `space_before_colon`
1454 Leave a space before the colon.
1456 - **Default value**: `false`
1457 - **Possible values**: `true`, `false`
1460 #### `false` (default):
1463 fn lorem<T: Eq>(t: T) {
1464 let lorem: Dolor = Lorem {
1474 fn lorem<T : Eq>(t : T) {
1475 let lorem : Dolor = Lorem {
1482 See also: [`space_after_colon`](#space_after_colon).
1484 ## `struct_field_align_threshold`
1486 The maximum diff of width between struct fields to be aligned with each other.
1488 - **Default value** : 0
1489 - **Possible values**: any positive integer
1512 ## `spaces_around_ranges`
1514 Put spaces around the .. and ... range operators
1516 - **Default value**: `false`
1517 - **Possible values**: `true`, `false`
1520 #### `false` (default):
1529 let lorem = 0 .. 10;
1532 ## `spaces_within_parens_and_brackets`
1534 Put spaces within non-empty generic arguments, parentheses, and square brackets
1536 - **Default value**: `false`
1537 - **Possible values**: `true`, `false`
1540 #### `false` (default):
1543 // generic arguments
1544 fn lorem<T: Eq>(t: T) {
1548 // non-empty parentheses
1549 fn lorem<T: Eq>(t: T) {
1550 let lorem = (ipsum, dolor);
1553 // non-empty square brackets
1554 let lorem: [usize; 2] = [ipsum, dolor];
1560 // generic arguments
1561 fn lorem< T: Eq >(t: T) {
1565 // non-empty parentheses
1566 fn lorem<T: Eq>( t: T ) {
1567 let lorem = ( ipsum, dolor );
1570 // non-empty square brackets
1571 let lorem: [ usize; 2 ] = [ ipsum, dolor ];
1574 ## `struct_lit_single_line`
1576 Put small struct literals on a single line
1578 - **Default value**: `true`
1579 - **Possible values**: `true`, `false`
1582 #### `true` (default):
1585 let lorem = Lorem { ipsum: dolor, sit: amet };
1597 See also: [`indent_style`](#indent_style).
1602 Number of spaces per tab
1604 - **Default value**: `4`
1605 - **Possible values**: any positive integer
1612 let ipsum = dolor();
1614 "amet consectetur adipiscing elit."
1623 let ipsum = dolor();
1625 "amet consectetur adipiscing elit."
1630 See also: [`hard_tabs`](#hard_tabs).
1635 How to handle trailing commas for lists
1637 - **Default value**: `"Vertical"`
1638 - **Possible values**: `"Always"`, `"Never"`, `"Vertical"`
1641 #### `"Vertical"` (default):
1644 let Lorem { ipsum, dolor, sit } = amet;
1658 let Lorem { ipsum, dolor, sit, } = amet;
1672 let Lorem { ipsum, dolor, sit } = amet;
1683 See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
1685 ## `trailing_semicolon`
1687 Add trailing semicolon after break, continue and return
1689 - **Default value**: `true`
1690 - **Possible values**: `true`, `false`
1693 #### `true` (default):
1707 ## `type_punctuation_density`
1709 Determines if `+` or `=` are wrapped in spaces in the punctuation of types
1711 - **Default value**: `"Wide"`
1712 - **Possible values**: `"Compressed"`, `"Wide"`
1715 #### `"Wide"` (default):
1718 fn lorem<Ipsum: Dolor + Sit = Amet>() {
1723 #### `"Compressed"`:
1726 fn lorem<Ipsum: Dolor+Sit=Amet>() {
1731 ## `use_try_shorthand`
1733 Replace uses of the try! macro by the ? shorthand
1735 - **Default value**: `false`
1736 - **Possible values**: `true`, `false`
1739 #### `false` (default):
1742 let lorem = try!(ipsum.map(|dolor|dolor.sit()));
1748 let lorem = ipsum.map(|dolor| dolor.sit())?;
1754 Break comments to fit on the line
1756 - **Default value**: `false`
1757 - **Possible values**: `true`, `false`
1760 #### `false` (default):
1763 // 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.
1769 // Lorem ipsum dolor sit amet, consectetur adipiscing elit,
1770 // sed do eiusmod tempor incididunt ut labore et dolore
1771 // magna aliqua. Ut enim ad minim veniam, quis nostrud
1772 // exercitation ullamco laboris nisi ut aliquip ex ea
1773 // commodo consequat.
1776 ## `match_arm_blocks`
1778 Wrap the body of arms in blocks when it does not fit on the same line with the pattern of arms
1780 - **Default value**: `true`
1781 - **Possible values**: `true`, `false`
1784 #### `true` (default):
1789 foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x)
1791 false => println!("{}", sit),
1800 foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo(x),
1801 false => println!("{}", sit),
1805 See also: [`match_block_trailing_comma`](#match_block_trailing_comma).
1809 What Write Mode to use when none is supplied: Replace, Overwrite, Display, Diff, Coverage
1811 - **Default value**: `"Overwrite"`
1812 - **Possible values**: `"Checkstyle"`, `"Coverage"`, `"Diff"`, `"Display"`, `"Overwrite"`, `"Plain"`, `"Replace"`
1815 ## `blank_lines_upper_bound`
1817 Maximum number of blank lines which can be put between items. If more than this number of consecutive empty
1818 lines are found, they are trimmed down to match this integer.
1820 - **Default value**: `1`
1821 - **Possible values**: *unsigned integer*
1870 See also: [`blank_lines_lower_bound`](#blank_lines_lower_bound)
1872 ## `blank_lines_lower_bound`
1874 Minimum number of blank lines which must be put between items. If two items have fewer blank lines between
1875 them, additional blank lines are inserted.
1877 - **Default value**: `0`
1878 - **Possible values**: *unsigned integer*
1882 Original Code (rustfmt will not change it with the default value of `0`):