HiveBrain v1.2.0
Get Started
← Back to all entries
snippetbashTip

rustfmt — Format Rust source code. More information: <https://github.com/rust-lang/rustfmt>.

Submitted by: @import:tldr-pages··
0
Viewed 0 times
commandformatrustsourcerustfmtclicodemore

Problem

How to use the rustfmt command: Format Rust source code. More information: <https://github.com/rust-lang/rustfmt>.

Solution

rustfmt — Format Rust source code. More information: <https://github.com/rust-lang/rustfmt>.

Format a file, overwriting the original file in-place:
rustfmt {{path/to/source.rs}}


Check a file for formatting and display any changes on the console:
rustfmt --check {{path/to/source.rs}}


Backup any modified files before formatting (the original file is renamed with a .bk extension):
rustfmt --backup {{path/to/source.rs}}


Format code using a specific Rust style edition (formatting rules) verbosely:
rustfmt --style-edition {{2015|2018|2021|2024}} {{[-v|--verbose]}} {{path/to/source1.rs path/to/source2.rs ...}}


Format code using a specific Rust edition (language features and parsing):
rustfmt --edition {{2015|2018|2021|2024}} {{path/to/source1.rs path/to/source2.rs ...}}

Code Snippets

Format a file, overwriting the original file in-place

rustfmt {{path/to/source.rs}}

Check a file for formatting and display any changes on the console

rustfmt --check {{path/to/source.rs}}

Backup any modified files before formatting (the original file is renamed with a `.bk` extension)

rustfmt --backup {{path/to/source.rs}}

Format code using a specific Rust style edition (formatting rules) verbosely

rustfmt --style-edition {{2015|2018|2021|2024}} {{[-v|--verbose]}} {{path/to/source1.rs path/to/source2.rs ...}}

Format code using a specific Rust edition (language features and parsing)

rustfmt --edition {{2015|2018|2021|2024}} {{path/to/source1.rs path/to/source2.rs ...}}

Context

tldr-pages: common/rustfmt

Revisions (0)

No revisions yet.