Chapter 3. The rustfmt formatting tool
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: On Red Hat Enterprise Linux 9: 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: Replace < source_file > with the name of your source file. Alternatively, you can replace < source_file > with standard input. rustfmt then provides its output in standard output. On Red Hat Enterprise Linux 9: Replace < source_file > with the name of your source file. Alternatively, you can replace < source_file > with standard input. rustfmt then provides its output in standard output. Note 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: On Red Hat Enterprise Linux 9: Note 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: On Red Hat Enterprise Linux 9: To configure the rustfmt tool, create the rustfmt.toml configuration file in the project directory and add your configurations to the file. You can find the configuration options in the Configurations.md file. On Red Hat Enterprise Linux 8, you can find it under the following path: /usr/share/doc/rustfmt/Configurations.md On Red Hat Enterprise Linux 9, you can find it under the following path: /usr/share/doc/rustfmt/Configurations.md
yum install rustfmt dnf install rustfmt rustfmt < source-file > rustfmt < source-file > cargo fmt cargo fmt rustfmt --help rustfmt --help