本記事ではRustのCargoコマンドについて記述します。
Cargoとは？
Cargo/Rustについては以下の記事で説明しているので、そちらをご参照ください。
https://qiita.com/Kanade_dev/items/eec3b714f8271cc44b46
RustProject
このセクションでは、 Rustプロジェクトに関するコマンドについて説明します。
Cargo new
これは新しいRustプロジェクトを作るためのコマンドです。
cargo new new-project
このコマンドでは、カレントディレクトリにnew-projectというディレクトリが生成され、Rustプロジェクトがセットアップされます。
- Cargo.toml
- .gitignore
- /src/main.rs
Carg init
これは、既存のプロジェクトをRustプロジェクトへ初期化するコマンドです。
cargo init
カレントディレクトリの名前でRustプロジェクトがセットアップされ、
- .gitignore
- Cargo.toml
- /src/main.rs
が生成されます。
Build
このセクションでは、Rustプロジェクトのビルドに関するコマンドについて説明します。
Cargo build
これは、Rustのデバッグ・テスト用にバイナリにビルドします。
cargo build
Cargo build --release
これは、リリース、本番環境向けにビルドされ、最適化されるため、サイズが小さくなります。
cargo build --release
Cargo build --timing
これは、 クレートのビルドにかかる時間を表示します。
cargo build --taiming
Cargo run
これは、ビルド->実行までを一つのコマンドで行うコマンドです。
cargo run
Cargo check
これは、構文エラーなどがないかを確認するコマンドです。
cargo check
Cargo test
これは、記述されているテストを実行するコマンドです。
cargo test
Cargo fix
これは、コンパイラが出す警告を自動で修正してくれるコマンドです。
cargo fix
ドキュメント
cargo docで/target/docにドキュメントが生成され、オプション-- openをつけることでブラウザで自動的に開いてくれます。
クレート
cargo add
これはクレートを追加するコマンドです。
cargo add {クレート名}
Cargo remove
これはクレートを削除するコマンドです。
cargo remove {クレート名}
Cargo search
これはクレートを検索するコマンドです。
cargo search {キーワード}
Cargo clean
これは、ビルドキャッシュをキレイにするコマンドです。
cargo clean
CLIなど
cargo install/uninstallで Rustの CLIなどをインストール・アンインストールできます。
cargo publish
Cargoクレートを公開するコマンドなどは別の記事で説明する予定です。