Chapter 2. The Cargo build tool

2.1. The Cargo directory structure and file placements
リンクのコピー

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
リンクのコピー

Create a new Rust project that is set up according to the Cargo conventions. For more information on Cargo conventions, see The Cargo directory structure and file placements.

Procedure

Create a Rust project:
```
cargo new --bin <project_name>
```
```
$ cargo new --bin <project_name>
```
Copy to Clipboard Toggle word wrap
Replace <project_name> with your project name.
To edit the project code, edit the main executable file main.rs and add new source files to the src subdirectory.

2.3. Creating a Rust library project
リンクのコピー

Complete the following steps to create a Rust library project by using the Cargo build tool.

Procedure

Create a Rust library project:
```
cargo new --lib <project_name>
```
```
$ cargo new --lib <project_name>
```
Copy to Clipboard Toggle word wrap
Replace <project_name> with the name of your Rust project.
To edit the project code, edit the src/lib.rs source file.

2.4. Building a Rust project
リンクのコピー

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.

Procedure

In the Rust project directory, build the project:
```
cargo build
```
```
$ cargo build
```
Copy to Clipboard Toggle word wrap
To verify that your Rust program can be built when you do not need to build an executable file, enter:
```
cargo check
```
```
$ cargo check
```
Copy to Clipboard Toggle word wrap

2.5. Building a Rust project in release mode
リンクのコピー

Build your Rust project in release mode by 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 by using the rustc compiler.

For information on compiling your project in debug mode, see Building a Rust project.

Prerequisites

An existing Rust project.

Procedure

In the Rust project directory, build the project in release mode:
```
cargo build --release
```
```
$ cargo build --release
```
Copy to Clipboard Toggle word wrap
To verify that your Rust program can be built when you do not need to build an executable file, enter:
```
cargo check
```
```
$ cargo check
```
Copy to Clipboard Toggle word wrap

2.6. Running a Rust program
リンクのコピー

Run your Rust project by 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.

Procedure

To run a Rust program managed as a project by Cargo, enter in the project directory:
```
cargo run
```
```
$ cargo run
```
Copy to Clipboard Toggle word wrap
If your program has not been built yet, Cargo builds your program before running it.

2.7. Testing a Rust project
リンクのコピー

Test your Rust program using the Cargo build tool. Cargo first rebuilds your project and then runs the tests found in the project. Test functions must be 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.

Procedure

Add the #[test] attribute in front of your function.
Enter in the project directory:
```
cargo test
```
```
$ cargo test
```
Copy to Clipboard Toggle word wrap

2.8. Testing a Rust project in release mode
リンクのコピー

Test your Rust program in release mode by 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. Test functions must be 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.

Procedure

Add the #[test] attribute in front of your function.
Enter in the project directory:
```
cargo test --release
```
```
$ cargo test --release
```
Copy to Clipboard Toggle word wrap

2.9. Configuring Rust project dependencies
リンクのコピー

Configure the dependencies of your Rust project by 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.

Procedure

In your project directory, edit the Cargo.toml file, and list each dependency in the following format in the [dependencies] section:
```
<crate_name> = <version>
```
```
<crate_name> = <version>
```
Copy to Clipboard Toggle word wrap
Rust code packages are called crates.
Rebuild your project:
```
cargo build
```
```
$ cargo build
```
Copy to Clipboard Toggle word wrap
Run your project:
```
cargo run
```
```
$ cargo run
```
Copy to Clipboard Toggle word wrap

2.10. Building documentation for a Rust project
リンクのコピー

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

Procedure

In your code, use three slashes /// at the beginning of a line to mark the line for extracting the comment for documentation.
Build the documentation:
```
cargo doc --no-deps
```
```
$ cargo doc --no-deps
```
Copy to Clipboard Toggle word wrap
The command stores the generated documentation in the .target/doc/ directory.

2.11. Compiling code into a WebAssembly binary with Rust
リンクのコピー

Complete the following steps to install the WebAssembly standard library.

Prerequisites

Rust Toolset is installed.

Procedure

Install the WebAssembly standard library:

On RHEL 8, enter:

yum install rust-std-static-wasm32-unknown-unknown

# yum install rust-std-static-wasm32-unknown-unknown

Copy to Clipboard

Toggle word wrap

On RHEL 9 and 10, enter:

dnf install rust-std-static-wasm32-unknown-unknown

# dnf install rust-std-static-wasm32-unknown-unknown

Copy to Clipboard

Toggle word wrap

Use WebAssembly with Cargo:
```
cargo <command> --target wasm32-unknown-unknown
```
```
$ cargo <command> --target wasm32-unknown-unknown
```
Copy to Clipboard Toggle word wrap
Replace <command> with the Cargo command you want to run.

2.12. Vendoring Rust project dependencies
リンクのコピー

Create a local copy of the dependencies of your Rust project for offline redistribution and reuse 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

Procedure

To vendor your Rust project with dependencies by using Cargo, enter in the project directory:
```
cargo vendor
```
```
$ cargo vendor
```
Copy to Clipboard Toggle word wrap

このコンテンツは選択した言語では利用できません。

2.1. The Cargo directory structure and file placements
リンクのコピー

2.2. Creating a Rust project
リンクのコピー

2.3. Creating a Rust library project
リンクのコピー

2.4. Building a Rust project
リンクのコピー

2.5. Building a Rust project in release mode
リンクのコピー

2.6. Running a Rust program
リンクのコピー

2.7. Testing a Rust project
リンクのコピー

2.8. Testing a Rust project in release mode
リンクのコピー

2.9. Configuring Rust project dependencies
リンクのコピー

2.10. Building documentation for a Rust project
リンクのコピー

2.11. Compiling code into a WebAssembly binary with Rust
リンクのコピー

2.12. Vendoring Rust project dependencies
リンクのコピー

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

このコンテンツは選択した言語では利用できません。

Chapter 2. The Cargo build tool

2.1. The Cargo directory structure and file placementsリンクのコピーリンクがクリップボードにコピーされました!

2.2. Creating a Rust projectリンクのコピーリンクがクリップボードにコピーされました!

2.3. Creating a Rust library projectリンクのコピーリンクがクリップボードにコピーされました!

2.4. Building a Rust projectリンクのコピーリンクがクリップボードにコピーされました!

2.5. Building a Rust project in release modeリンクのコピーリンクがクリップボードにコピーされました!

2.6. Running a Rust programリンクのコピーリンクがクリップボードにコピーされました!

2.7. Testing a Rust projectリンクのコピーリンクがクリップボードにコピーされました!

2.8. Testing a Rust project in release modeリンクのコピーリンクがクリップボードにコピーされました!

2.9. Configuring Rust project dependenciesリンクのコピーリンクがクリップボードにコピーされました!

2.10. Building documentation for a Rust projectリンクのコピーリンクがクリップボードにコピーされました!

2.11. Compiling code into a WebAssembly binary with Rustリンクのコピーリンクがクリップボードにコピーされました!

2.12. Vendoring Rust project dependenciesリンクのコピーリンクがクリップボードにコピーされました!

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

2.1. The Cargo directory structure and file placements
リンクのコピー

2.2. Creating a Rust project
リンクのコピー

2.3. Creating a Rust library project
リンクのコピー

2.4. Building a Rust project
リンクのコピー

2.5. Building a Rust project in release mode
リンクのコピー

2.6. Running a Rust program
リンクのコピー

2.7. Testing a Rust project
リンクのコピー

2.8. Testing a Rust project in release mode
リンクのコピー

2.9. Configuring Rust project dependencies
リンクのコピー

2.10. Building documentation for a Rust project
リンクのコピー

2.11. Compiling code into a WebAssembly binary with Rust
リンクのコピー

2.12. Vendoring Rust project dependencies
リンクのコピー