Chapter 3. rustfmt
The rustfmt tool provides automatic formatting of Rust source code.
Rust Toolset is distributed with rustfmt 1.35.0.
3.1. Installing rustfmt Copy linkLink copied to clipboard!
For Red Hat Enterprise Linux 7:
# yum install rust-toolset-1.35-rustfmtFor Red Hat Enterprise Linux 8:
# dnf install rustfmt
3.2. Using rustfmt as a standalone tool Copy linkLink copied to clipboard!
To format a rust source file and all its dependencies with the rustfmt tool:
For Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.35 'rustfmt source-file'For Red Hat Enterprise Linux 8:
$ rustfmt source-file
Replace source-file with path to the source file.
By default, rustfmt modifies the affected files in place without displaying details or creating backups. To change the behavior, use the --write-mode value option. For further details see the help mesage of rustfmt:
For Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.35 'rustfmt --help'For Red Hat Enterprise Linux 8:
$ rustfmt --help
Additionally, rustfmt accepts standard input instead of a file and provides its output in standard output.
3.3. Using rustfmt with cargo Copy linkLink copied to clipboard!
To format all source files in a cargo crate:
For Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.35 'cargo fmt'For Red Hat Enterprise Linux 8:
$ cargo fmt
To change the rustfmt formatting options, create the configuration file rustfmt.toml in the project directory and supply the configuration there. For further details see the help message of rustfmt:
For Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.35 'rustfmt --config-help'For Red Hat Enterprise Linux 8:
$ rustfmt --config-help
3.4. Additional Resources Copy linkLink copied to clipboard!
Help messages of
rustfmt:For Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.35 'rustfmt --help' $ scl enable rust-toolset-1.35 'rustfmt --config-help'For Red Hat Enterprise Linux 8:
$ rustfmt --help $ rustfmt --config-help
Configuring Rustfmt in
Configurations.md:Location in Red Hat Enterprise Linux 7:
/opt/rh/rust-toolset-1.35/usr/share/doc/rust-toolset-1.35-rustfmt-1.35.0/Configurations.mdLocation in Red Hat Enterprise Linux 8:
/usr/share/doc/rustfmt/Configurations.md