パッケージ管理(cargo
)
1$ cargo search パッケージ名
2$ cargo install パッケージ名
3$ cargo new プロジェクト名
4$ cargo build
5$ cargo run
6$ cargo check
brew install rust
するとrustc
コマンドとcargo
コマンドがインストールされます。
パッケージを管理したり、自作パッケージを作成する場合はcargo
を使います。
パッケージの階層構造
Rustのパッケージは パッケージ
> クレート
> モジュール
という階層構造になっています。
パッケージは複数のクレートを含むことができます。
モジュールはクレートの中でグループ化されたコードのことです。
また、複数のパッケージをワークスペース
にまとめることができます。
公式ドキュメントを読んだり、自作パッケージを作成するときに、このイメージは役に立つと思います。
パッケージを探したい(search
)
1$ cargo search パッケージ名(のキーワード)
2$ cargo search パッケージ名 --limit 件数
パッケージ名(もしくはキーワード)で公開されているパッケージを検索できます。
デフォルトで10件が表示されます。--limit
オプションで表示件数を変更できます。
パッケージインストールしたい(install
)
1$ cargo install パッケージ名
2$ cargo uninstall パッケージ名
公開されているパッケージのバイナリーをインストールします。
バイナリーは$HOME/.cargo/bin
にインストールされます。
コマンドとして実行する場合、シェルのPATH設定が必要です。
自作パッケージを作成したい(new
)
1$ cargo new プロジェクト名
cargo new
すると必要なファイル一式が自動で生成されます。
パッケージ名はsnake_case
にする必要があります。
1$ tree -a .
2.
3├── .git/
4├── Cargo.toml
5└── src
6 └── main.rs
作成されたディレクトリの中身を確認すると、Git関係のファイルも生成されていました。
ビルドしたい(build
)
1$ cargo build
2$ cargo build --release
ビルド&実行したい(run
)
1$ cargo run
ビルドできるかを確認したい(check
)
1$ cargo check
実行ファイルを作成せずに、ビルド可能かを確認できます。
cargo build
より高速に動作するので、コードを書きながらチェックするのにもってこいです。
外部クレートを追加したい(add
)
1$ cargo add パッケージ名
2$ cargo remove パッケージ名
自作パッケージが依存する外部クレートを追加する場合はcargo add
します。
依存関係はCargo.toml
に保存されます。
外部クレートを更新したい(update
)
1$ cargo update
2$ cargo update --dry-run
依存している外部クレートを更新する場合はcargo update
します。
最新版がインストールされ、Cargo.lock
が更新されます。
ドキュメントを作成したい
1$ cargo doc # プロジェクトのドキュメントを作成
2$ cargo doc --open # 作成したドキュメントを開く
cargo doc
でプロジェクトのドキュメントを作成できます。
依存している外部クレートのドキュメントも同時に取得できます。