Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2024: Document rustfmt overflow_delimited_expr #352

Merged
merged 2 commits into from
Dec 31, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 83 additions & 3 deletions src/rust-2024/rustfmt-overflow-delimited-expr.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,90 @@
# Rustfmt: Combine all delimited exprs as last argument

This feature is not yet implemented.
More information may be found in <https://github.com/rust-lang/rust/pull/114764>.

## Summary

* Some expressions as the last argument in a list will now overflow instead of indent.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps: Some expressions with multi-line final arguments will now format as a single line, with the final expression overflowing

?? or something like that. I think the gist is that we're actually formatting more things as a single line + overflow.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That looks better, I have updated with that suggestion.


## Details

When structs, slices, arrays, and block/array-like macros are used as the last argument in an expression list, they are now allowed to overflow (like blocks/closures) instead of being indented on a new line.

```rust,ignore
// Edition 2021

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,
],
);
}
```

This now formats as the following in the 2024 style edition:

```rust,ignore
// Edition 2024

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,
]);
}
```

## Migration

The change can be applied automatically by running `cargo fmt` or `rustfmt` with the 2024 Edition. See the [Style edition] chapter for more information on migrating and how style editions work.

[Style edition]: rustfmt-style-edition.md
Loading