Este contenido no está disponible en el idioma seleccionado.
Using Rust 1.58.1 Toolset
Installing and using Rust 1.58.1 Toolset
Abstract
Making open source more inclusive Copiar enlaceEnlace copiado en el portapapeles!
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright’s message.
Chapter 1. Rust Toolset Copiar enlaceEnlace copiado en el portapapeles!
Rust Toolset is a Red Hat offering for developers on Red Hat Enterprise Linux (RHEL). It provides the rustc compiler for the Rust programming language, the Rust package manager Cargo, the rustfmt formatting tool, and required libraries.
Rust Toolset is distributed as a part of Red Hat Developer Tools for Red Hat Enterprise Linux 7. For Red Hat Enterprise Linux 8, Rust Toolset is available as a module. Rust Toolset is available as packages for Red Hat Enterprise Linux 9.
1.1. Rust Toolset components Copiar enlaceEnlace copiado en el portapapeles!
The following components are available as part of Rust Toolset:
| Name | Version | Description |
|---|---|---|
|
| 1.58.1 | The Rust compiler front-end for LLVM. |
|
| 1.58.1 | A build system and dependency manager for Rust. |
|
| 1.58.1 | A tool for automatic formatting of Rust code. |
1.2. Rust Toolset compatibility Copiar enlaceEnlace copiado en el portapapeles!
Rust Toolset is available for Red Hat Enterprise Linux 7 and Red Hat Enterprise Linux 8 and Red Hat Enterprise Linux 9 on the following architectures:
- AMD and Intel 64-bit
- 64-bit ARM (RHEL 8 and RHEL 9)
- IBM Power Systems, Little Endian
- IBM Power Systems, Big Endian (Only RHEL 7)
- 64-bit IBM Z
1.3. Getting access to Rust Toolset on Red Hat Enterprise Linux 7 Copiar enlaceEnlace copiado en el portapapeles!
To be able to install Rust Toolset on Red Hat Enterprise Linux 7, you must access and enable Red Hat Developer Tools and Red Hat Software Collections repositories.
If these repositories are already attached to your system, see Installing Rust Toolset.
Procedure
Install
Wgetby running:# yum install wgetDownload the latest subscription data by running:
# subscription-manager refreshRegister your system by running:
# subscription-manager registerTo register your system using a graphical user interface (GUI), follow the Registering and Unregistering a System guide.
Display a list of all available subscriptions and identify the pool ID by running:
# subscription-manager list --available-
Find the pool ID on the line beginning with
Pool ID. Attach the subscription that provides access to the
Red Hat Developer Toolsrepository to your system by running:# subscription-manager attach --pool=<pool ID from the subscription>-
Replace
<pool ID from the subscription>with the pool ID you identified in the previous step.
-
Replace
Verify which subscriptions are attached to your system by running:
# sudo subscription-manager list --consumedEnable the
rhel-7-variant-devtools-rpmsrepository by running:# subscription-manager repos --enable rhel-7-<variant>-devtools-rpmsReplace
<variant>with your Red Hat Enterprise Linux system variant:serverorworkstation.Use
serverto access the widest range of development tools.
Enable the
rhel-variant-rhscl-7-rpmsrepository by running:# subscription-manager repos --enable rhel-<variant>-rhscl-7-rpms-
Replace
<variant>with your Red Hat Enterprise Linux system variant:serverorworkstation.
-
Replace
Add the Red Hat Developer Tools GPG key to your system by running:
# cd /etc/pki/rpm-gpg # wget -O RPM-GPG-KEY-redhat-devel https://www.redhat.com/security/data/a5787476.txt # rpm --import RPM-GPG-KEY-redhat-devel
1.4. Installing Rust Toolset Copiar enlaceEnlace copiado en el portapapeles!
Complete the following steps to install Rust Toolset including all development and debugging tools as well as dependent packages. Note that Rust Toolset has a dependency on LLVM Toolset.
Prerequisites
-
On Red Hat Enterprise Linux 7, a subscription providing access to the Red Hat Developer Tools content set is attached to your system.
To attach the subscription, see Getting access to Rust Toolset on Red Hat Enterprise Linux 7. - All available Red Hat Enterprise Linux updates are installed.
Procedure
On Red Hat Enterprise Linux 7, install the rust-toolset-1.58 collection by running:
# yum install rust-toolset-1.58
On Red Hat Enterprise Linux 8, install the rust-toolset module by running:
# yum module install rust-toolset
On Red Hat Enterprise Linux 9, install the rust-toolset package by running:
# dnf install rust-toolset
1.5. Installing Rust documentation Copiar enlaceEnlace copiado en el portapapeles!
The The Rust Programming Language book is available as installable documentation.
Prerequisites
-
Rust Toolset is installed.
For more information, see Installing Rust Toolset.
Procedure
To install the rust-doc package, run the following command:
On Red Hat Enterprise Linux 7:
# yum install rust-toolset-1.58-rust-docYou can find the The Rust Programming Language book under the following path:
/opt/rh/rust-toolset-1.58/root/usr/share/doc/rust/html/index.html.
You can find the API documentation for all Rust code packages under the following path:/opt/rh/rust-toolset-1.58/root/usr/share/doc/rust/html/std/index.html.On Red Hat Enterprise Linux 8:
# yum install rust-docYou can find the The Rust Programming Language book under the following path:
/usr/share/doc/rust/html/index.html.
You can find the API documentation for all Rust code packages under the following path:/usr/share/doc/rust/html/std/index.html.On Red Hat Enterprise Linux 9:
# dnf install rust-docYou can find the The Rust Programming Language book under the following path:
/usr/share/doc/rust/html/index.html.
You can find the API documentation for all Rust code packages under the following path:/usr/share/doc/rust/html/std/index.html.
1.6. Installing Cargo documentation Copiar enlaceEnlace copiado en el portapapeles!
The Cargo, Rust’s Package Manager book is available as installable documentation for Cargo.
Prerequisites
-
Rust Toolset is installed.
For more information, see Installing Rust Toolset.
Procedure
To install the
cargo-docpackage, run:On Red Hat Enterprise Linux 7:
# yum install rust-toolset-1.58-cargo-docYou can find the Cargo book under the following path:
/opt/rh/rust-toolset-1.58/root/usr/share/doc/cargo/html/index.html.On Red Hat Enterprise Linux 8:
# yum install cargo-docYou can find the Cargo, Rust’s Package Manager book under the following path:
/usr/share/doc/cargo/html/index.html.On Red Hat Enterprise Linux 9:
# dnf install cargo-docYou can find the Cargo, Rust’s Package Manager book under the following path:
/usr/share/doc/cargo/html/index.html.
Chapter 2. The Cargo build tool Copiar enlaceEnlace copiado en el portapapeles!
Cargo is a build tool and front end for the Rust compiler rustc as well as a package and dependency manager. It allows Rust projects to declare dependencies with specific version requirements, resolves the full dependency graph, downloads packages, and builds as well as tests your entire project.
Rust Toolset is distributed with Cargo 1.58.1.
2.1. The Cargo directory structure and file placements Copiar enlaceEnlace copiado en el portapapeles!
The Cargo build tool uses set conventions for defining the directory structure and file placement within a Cargo package. Running the cargo new command generates the package directory structure and templates for both a manifest and a project file. By default, it also initializes a new Git repository in the package root directory.
For a binary program, Cargo creates a directory project_name containing a text file named Cargo.toml and a subdirectory src containing a text file named main.rs.
2.2. Creating a Rust project Copiar enlaceEnlace copiado en el portapapeles!
Create a new Rust project that is set up according to the Cargo conventions. For more information on Cargo conventions, see Cargo directory structure and file placements.
Procedure
Create a Rust project by running the following command:
On Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.58 'cargo new --bin <project_name>'-
Replace
<project_name>with your project name.
-
Replace
On Red Hat Enterprise Linux 8:
$ cargo new --bin <project_name>-
Replace
<project_name>with your project name.
-
Replace
On Red Hat Enterprise Linux 9:
$ cargo new --bin <project_name>-
Replace
<project_name>with your project name.
-
Replace
To edit the project code, edit the main executable file main.rs and add new source files to the src subdirectory.
Additional resources
- For information on configuring your project and adding dependencies, see Configuring Rust project dependencies.
2.3. Creating a library for a Rust project Copiar enlaceEnlace copiado en el portapapeles!
Complete the following steps to create a library for your Rust project using the Cargo build tool.
Prerequisites
-
An existing Rust project.
For information on how to create a Rust project, see Creating a Rust project.
Procedure
To create a library for your Rust project, run the following command:
On Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.58 'cargo new --lib <project_name>'-
Replace
<project_name>with the name of your Rust project.
-
Replace
On Red Hat Enterprise Linux 8:
$ cargo new --lib <project_name>-
Replace
<project_name>with the name of your Rust project.
-
Replace
On Red Hat Enterprise Linux 9:
$ cargo new --lib <project_name>-
Replace
<project_name>with the name of your Rust project.
-
Replace
2.4. Building a Rust project Copiar enlaceEnlace copiado en el portapapeles!
Build your Rust project using the Cargo build tool. Cargo resolves all dependencies of your project, downloads missing dependencies, and compiles it using the rustc compiler.
By default, projects are built and compiled in debug mode. For information on compiling your project in release mode, see Building a Rust project in release mode.
Prerequisites
-
An existing Rust project.
For information on how to create a Rust project, see Creating a Rust project.
Procedure
To build a Rust project managed by Cargo, run in the project directory:
On Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.58 'cargo build'On Red Hat Enterprise Linux 8:
$ cargo buildOn Red Hat Enterprise Linux 9:
$ cargo build
- To verify that your Rust program can be built when you do not need to build an executable file, run:
$ cargo check
2.5. Building a Rust project in release mode Copiar enlaceEnlace copiado en el portapapeles!
Build your Rust project in release mode using the Cargo build tool. Release mode is optimizing your source code and can therefore increase compilation time while ensuring that the compiled binary will run faster. Use this mode to produce optimized artifacts suitable for release and production.
Cargo resolves all dependencies of your project, downloads missing dependencies, and compiles it using the rustc compiler.
For information on compiling your project in debug mode, see Building a Rust project.
Prerequisites
-
An existing Rust project.
For information on how to create a Rust project, see Creating a Rust project.
Procedure
To build the project in release mode, run:
On Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.58 'cargo build --release'On Red Hat Enterprise Linux 8:
$ cargo build --releaseOn Red Hat Enterprise Linux 9:
$ cargo build --release
- To verify that your Rust program can be build when you do not need to build an executable file, run:
$ cargo check
2.6. Running a Rust program Copiar enlaceEnlace copiado en el portapapeles!
Run your Rust project using the Cargo build tool. Cargo first rebuilds your project and then runs the resulting executable file. If used during development, the cargo run command correctly resolves the output path independently of the build mode.
Prerequisites
-
A built Rust project.
For information on how to build a Rust project, see Building a Rust project.
Procedure
To run a Rust program managed as a project by Cargo, run in the project directory:
On Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.58 'cargo run'On Red Hat Enterprise Linux 8:
$ cargo runOn Red Hat Enterprise Linux 9:
$ cargo run
If your program has not been built yet, Cargo builds your program before running it.
2.7. Testing a Rust project Copiar enlaceEnlace copiado en el portapapeles!
Test your Rust program using the Cargo build tool. Cargo first rebuilds your project and then runs the tests found in the project. Note that you can only test functions that are free, monomorphic, and take no arguments. The function return type must be either () or Result<(), E> where E: Error.
By default, Rust projects are tested in debug mode. For information on testing your project in release mode, see Testing a Rust project in release mode.
Prerequisites
-
A built Rust project.
For information on how to build a Rust project, see Building a Rust project.
Procedure
-
Add the test attribute
#[test]in front of your function. To run tests for a Rust project managed by Cargo, run in the project directory:
On Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.58 'cargo test'On Red Hat Enterprise Linux 8:
$ cargo testOn Red Hat Enterprise Linux 9:
$ cargo test
2.8. Testing a Rust project in release mode Copiar enlaceEnlace copiado en el portapapeles!
Test your Rust program in release mode using the Cargo build tool. Release mode is optimizing your source code and can therefore increase compilation time while ensuring that the compiled binary will run faster. Use this mode to produce optimized artifacts suitable for release and production.
Cargo first rebuilds your project and then runs the tests found in the project. Note that you can only test functions that are free, monomorphic, and take no arguments. The function return type must be either () or Result<(), E> where E: Error.
For information on testing your project in debug mode, see Testing a Rust project.
Prerequisites
-
A built Rust project.
For information on how to build a Rust project, see Building a Rust project.
Procedure
-
Add the test attribute
#[test]in front of your function. To run tests for a Rust project managed by Cargo in release mode, run in the project directory:
On Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.58 'cargo test --release'On Red Hat Enterprise Linux 8:
$ cargo test --releaseOn Red Hat Enterprise Linux 9:
$ cargo test --release
2.9. Configuring Rust project dependencies Copiar enlaceEnlace copiado en el portapapeles!
Configure the dependencies of your Rust project using the Cargo build tool. To specify dependencies for a project managed by Cargo, edit the file Cargo.toml in the project directory and rebuild your project. Cargo downloads the Rust code packages and their dependencies, stores them locally, builds all of the project source code including the dependency code packages, and runs the resulting executable.
Prerequisites
-
A built Rust project.
For information on how to build a Rust project, see Building a Rust project.
Procedure
-
In your project directory, open the file
Cargo.toml. Move to the section labelled
[dependencies].
Each dependency is listed on a new line in the following format:crate_name = versionRust code packages are called crates.
- Edit your dependencies.
Rebuild your project by running:
On Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.58 'cargo build'On Red Hat Enterprise Linux 8:
$ cargo buildOn Red Hat Enterprise Linux 9:
$ cargo build
Run your project by using the following command:
On Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.58 'cargo run'On Red Hat Enterprise Linux 8:
$ cargo runOn Red Hat Enterprise Linux 9:
$ cargo run
2.10. Building documentation for a Rust project Copiar enlaceEnlace copiado en el portapapeles!
Use the Cargo tool to generate documentation from comments in your source code that are marked for extraction. Note that documentation comments are extracted only for public functions, variables, and members.
Prerequisites
-
A built Rust project.
For information on how to build a Rust project, see Building a Rust project. -
Configured dependencies.
For more information on configuring dependencies, see Configuring Rust project dependencies.
Procedure
-
To mark comments for extraction, use three slashes
///and place your comment in the beginning of the line it is documenting.
Cargo supports the Markdown language for your comments. To build project documentation using Cargo, run in the project directory:
On Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.58 'cargo doc --no-deps'On Red Hat Enterprise Linux 8:
$ cargo doc --no-depsOn Red Hat Enterprise Linux 9:
$ cargo doc --no-deps
The generated documentation is located in the .target/doc directory.
2.11. Compiling code into a WebAssembly binary with Rust on Red Hat Enterprise Linux 8 and Red Hat Enterprise Linux 9 Beta Copiar enlaceEnlace copiado en el portapapeles!
Complete the following steps to install the WebAssembly standard library.
Prerequisites
-
Rust Toolset is installed.
For more information, see Installing Rust Toolset.
Procedure
To install the WebAssembly standard library, run:
On Red Hat Enterprise Linux 8:
# yum install rust-std-static-wasm32-unknown-unknownOn Red Hat Enterprise Linux 9:
# dnf install rust-std-static-wasm32-unknown-unknown
To use WebAssembly with Cargo, run:
On Red Hat Enterprise Linux 8:
# cargo <command> --target wasm32-unknown-unknownReplace <command> with the Cargo command you want to run.
On Red Hat Enterprise Linux 9:
# cargo <command> --target wasm32-unknown-unknownReplace <command> with the Cargo command you want to run.
2.12. Vendoring Rust project dependencies Copiar enlaceEnlace copiado en el portapapeles!
Create a local copy of the dependencies of your Rust project for offline redistribution and reuse using the Cargo build tool. This procedure is called vendoring project dependencies. The vendored dependencies including Rust code packages for building your project on a Windows operating system are located in the vendor directory. Vendored dependencies can be used by Cargo without any connection to the internet.
Prerequisites
-
A built Rust project.
For information on how to build a Rust project, see Building a Rust project. -
Configured dependencies.
For more information on configuring dependencies, see Configuring Rust project dependencies.
Procedure
To vendor your Rust project with dependencies using Cargo, run in the project directory:
On Red Hat Enterprise Linux 7:
$ scl enable rust-toolset-1.58 'cargo vendor'On Red Hat Enterprise Linux 8:
$ cargo vendorOn Red Hat Enterprise Linux 9:
$ cargo vendor
Chapter 3. The rustfmt formatting tool Copiar enlaceEnlace copiado en el portapapeles!
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 Copiar enlaceEnlace copiado en el portapapeles!
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 7:
# yum install rust-toolset-1.58-rustfmtOn Red Hat Enterprise Linux 8:
# yum install rustfmtOn Red Hat Enterprise Linux 9:
# dnf install rustfmt
3.2. Using rustfmt as a standalone tool Copiar enlaceEnlace copiado en el portapapeles!
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 7:
$ scl enable rust-toolset-1.58 '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 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 Copiar enlaceEnlace copiado en el portapapeles!
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 7:
$ scl enable rust-toolset-1.58 'cargo fmt'On Red Hat Enterprise Linux 8:
$ cargo fmtOn 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.
Chapter 4. Container images with Rust Toolset on RHEL 8 Copiar enlaceEnlace copiado en el portapapeles!
On RHEL 8, you can build your own Rust Toolset container images on top of Red Hat Universal Base Images (UBI) containers using Containerfiles.
4.1. Creating a container image of Rust Toolset on RHEL 8 Copiar enlaceEnlace copiado en el portapapeles!
On RHEL 8, Rust Toolset packages are part of the Red Hat Universal Base Images (UBIs) repositories. To keep the container size small, install only individual packages instead of the entire Rust Toolset.
Prerequisites
-
An existing Containerfile.
For more information on creating Containerfiles, see the Dockerfile reference page.
Procedure
- Visit the Red Hat Container Catalog.
- Select a UBI.
- Click Get this image and follow the instructions.
- To create a container containing Rust Toolset, add the following lines to your Containerfile:
FROM registry.access.redhat.com/ubi8/ubi:latest
RUN yum install -y rust-toolset
- To create a container image containing an individual package only, add the following lines to your Containerfile:
RUN yum install <package-name>
-
Replace
<package_name>with the name of the package you want to install.
Chapter 5. Changes in Rust 1.58.1 Toolset Copiar enlaceEnlace copiado en el portapapeles!
Rust Toolset has been updated from version 1.54.0 to 1.58.1 on RHEL 7 and RHEL 8. RHEL 9 Beta is distributed with Rust Toolset 1.58.1.
Notable changes include:
-
The Rust compiler now supports the 2021 edition of the language, featuring disjoint capture in closure,
IntoIteratorfor arrays, a new Cargo feature resolver, and more. - Added Cargo support for new custom profiles.
- Cargo now deduplicates compiler errors.
- Added new open range patterns.
- Added captured identifiers in format strings.