Ce contenu n'est pas disponible dans la langue sélectionnée.
Chapter 3. The rustfmt formatting tool
With the rustfmt formatting tool, you can automatically format the source code of your Rust programs. You can use rusftmt either as a standalone tool or with Cargo.
3.1. Installing rustfmt
Complete the following steps to install the rustfmt formatting tool.
Prerequisites
-
Rust Toolset is installed.
For more information, see Installing Rust Toolset.
Procedure
Run the following command to install rustfmt:
On Red Hat Enterprise Linux 8:
# yum install rustfmt
On Red Hat Enterprise Linux 9:
# dnf install rustfmt
3.2. Using rustfmt as a standalone tool
Use rustfmt as a standalone tool to format a Rust source file and all its dependencies. As an alternative, use rustfmt with the Cargo build tool. For more information, see Using rustfmt with Cargo.
Prerequisites
-
An existing Rust project.
For information on how to create a Rust project, see Creating a Rust project.
Procedure
To format a Rust source file using rustfmt as a standalone tool, run the following command:
On Red Hat Enterprise Linux 8:
$ rustfmt <source-file>-
Replace
<source_file>with the name of your source file.
Alternatively, you can replace<source_file>with standard input.rustfmtthen provides its output in standard output.
-
Replace
On Red Hat Enterprise Linux 9:
$ rustfmt <source-file>-
Replace
<source_file>with the name of your source file.
Alternatively, you can replace<source_file>with standard input.rustfmtthen provides its output in standard output.
-
Replace
By default, rustfmt modifies the affected files without displaying details or creating backups. To display details and create backups, run rustfmt with the --write-mode value.
3.3. Using rustfmt with the Cargo build tool
Use the rustfmt tool with Cargo to format a Rust source file and all its dependencies.
As an alternative, use rustfmt as a standalone tool. For more information, see Using rustfmt as a standalone tool.
Prerequisites
-
An existing Rust project.
For information on how to create a Rust project, see Creating a Rust project.
Procedure
To format all source files in a Cargo code package, run the following command:
On Red Hat Enterprise Linux 8:
$ cargo fmt
On Red Hat Enterprise Linux 9:
$ cargo fmt
To change the rustfmt formatting options, create the configuration file rustfmt.toml in the project directory and add your configurations to the file.
3.4. Additional resources
To display the help pages of
rustfmt, run:On Red Hat Enterprise Linux 8:
$ rustfmt --help
On Red Hat Enterprise Linux 9:
$ rustfmt --help
To configure the
rustfmttool, create therustfmt.tomlconfiguration file in the project directory and add your configurations to the file. You can find the configuration options in theConfigurations.mdfile.On Red Hat Enterprise Linux 8, you can find it under the following path:
/usr/share/doc/rustfmt/Configurations.mdOn Red Hat Enterprise Linux 9, you can find it under the following path:
/usr/share/doc/rustfmt/Configurations.md
