2024/01/25

Rustの開発環境の構築（MacOS）

目次

• Rustの開発環境の構築
  • Rustツールチェーンのインストール
  • 実際にrustup-init（インストーラー）を実行（セットアップ）
• RustでHello, world!
  • cargoコマンド
• Rustの開発で役立つツール
  • rust-analyzer
  • CodeLLDB
  • Rust Test Explorer
  • Rust Doc Viewer
  • crates
  • Even Better TOML
  • cargo-edit
  • cargo-watch
• 参考

Rustの開発環境の構築

• Rustの開発には、Rustツールチェーンが必要
  • （バイナリを実行する環境には不要）
• rustupで、Rustツールチェーンをインストール・管理
  • 直接、Rustツールチェーンをダウンロードできるが非推奨
• rustup-init（インストーラー）で、Rustツールチェーンとrustupをインストールできる

※ツールチェーンとは、一般にプログラム開発に使う一連の道具のこと。rustupも広義にはツールチェーンと言えるが、厳密に考えても仕方がない。

• Rustツールチェーン：
  • 構成
    • rustc：
      • Rustのコンパイラ
    • Cargo（カーゴ）：
      • Rustのパッケージマネージャー
      • （Node.jsでいうところのnpm）
    • std：
      • Rustの標準（standard）ライブラリ
  • 種類（リリースチャンネル）
    • stable（安定版）
    • beta（ベータ版）
    • nightly（開発版）
• rustup：
  • Rustツールチェーンのインストール
  • Rustツールチェーンの複数バージョン管理
  • クロスコンパイル用ターゲットのインストール
  • 開発支援ツールのインストール
  • （Node.jsでいうところのnvm や nodenv）
  • rustupの公式ドキュメント

Rustツールチェーンのインストール

• rustup-init（インストーラー）のインストール方法：
  • ①インストールコマンド 　or
  • ②Homebrew
    

# ①インストールコマンド でインストール
% curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

ヌギーは②brewでインストール

# ②Homebrew でインストール
% brew install rustup-init

実際にrustup-init（インストーラー）を実行（セットアップ）

rustup-initで、Rustツールチェーンをインストールしていく。

rustup-initコマンドでセットアップ開始！（されない場合は、ターミナルを再起動しましょう）

% rustup-init

しかし、ヌギーの環境ではすでにRustがインストールされており、警告⚠️が出てしまいました。

warning: it looks like you have an existing installation of Rust at:
warning: /opt/homebrew/bin
warning: It is recommended that rustup be the primary Rust installation.
warning: Otherwise you may have confusion unless you are careful with your PATH
warning: If you are sure that you want both rustup and your already installed Rust
warning: then please reply `y' or `yes' or set RUSTUP_INIT_SKIP_PATH_CHECK to yes
warning: or pass `-y' to ignore all ignorable checks.
error: cannot install while Rust is installed

/opt/homebrew/binにRustがインストールされているようです。 Rustのインストールはrustupを優先することをお勧めします。 そうでないと、PATH に注意しないと混乱する可能性があります。 もし、rustup と既にインストールされている Rust の両方が必要なのであれば、y か yes と答えるか、RUSTUP_INIT_SKIP_PATH_CHECK を yes に設定するか、-y を渡して無視できるチェックをすべて無視してください。

↑一旦無視して、Continue? (y/N)と出るので脳死でyesするとWelcome to Rustと歓迎され、続きます↓
（※後でスタッフがbrew uninstall rustしました）

# 続き
Welcome to Rust!

〜省略〜

This path will then be added to your PATH environment variable by
modifying the profile files located at:

  /Users/user/.profile
  /Users/user/.zshenv

〜省略〜

1) Proceed with installation (default)
2) Customize installation
3) Cancel installation
> // エンター（1以外を選ぶ場合は2または3と入力してからエンター）

↑この3択は環境構築の方法ですが、とりあえずヌギーはdefaultの「1」にするため、エンターを押しました。

このとき、「/Users/user/.profile」と「/Users/user/.zshenv」がないとエラーになるので、無い場合は空ファイルでいいので作成しましょう（人によってはこのファイルは異なるかもしれません）。

# 続き
info: profile set to 'default'

〜省略〜

Rust is installed now. Great!

To get started you may need to restart your current shell.
This would reload your PATH environment variable to include
Cargo's bin directory ($HOME/.cargo/bin).

To configure your current shell, run:
source "$HOME/.cargo/env"

↑と出るので、指示どおり「.cargo/env」を読み込み直し、パスを反映↓

% source "$HOME/.cargo/env"

• 「.cargo/env」ファイルは、単に「$HOME/.cargo/bin」のパスを通しているだけ
• 「$HOME/.cargo/bin」ディレクトリにrustc、cargo、rustupコマンドが格納されている

これでRustの開発で使用するコマンドが叩けるはずです↓

# cargo のバージョン確認
cargo --version
# rustc のバージョン確認
rustc --version
# rustdoc のバージョン確認
rustdoc --version
# rustup のバージョン確認
rustup --version

RustでHello, world!

カレントディレクトリ直下にRust プロジェクト作成

# cargo new (プロジェクト名)
% cargo new hello_rust
% cd hello_rust

or

カレントディレクトリ自体にRust プロジェクト作成

% mkdir hello_rust
% cd hello_rust
% cargo init

コンパイルして実行

% cargo run
   Compiling hello_rust v0.1.0 (/Users/user/my-space/hello_rust)
    Finished dev [unoptimized + debuginfo] target(s) in 2.80s
     Running `target/debug/hello_rust`
Hello, world!

※ファイル名に2単語以上使う場合は、アンダースコアで区切るのが慣例のよう

cargoコマンド

• cargo new を使ってプロジェクトを作成できる
• cargo build を使ってプロジェクトをビルドできる
• cargo run を使うとプロジェクトのビルドと実行を1ステップで行える
• cargo check を使うとバイナリを生成せずにプロジェクトをビルドして、エラーがないか確認できる
• Cargoは、ビルドの成果物をコードと同じディレクトリに保存するのではなく、target/debugディレクトリに格納する

Rustの開発で役立つツール

rust-analyzer

• Rust の Language Server / フォーマッター
  • rust-analyzer（vscode）
  • User Manual
  • フォーマットの設定ファイル：rustfmt.toml
    • Rustfmt
  • 主な機能
    • コード補完
    • 定義ジャンプ
    • ホバー時に型やドキュメントを表示する
    • インレイヒント
    • シンタックスハイライト

（rustfmt.toml）
tab_spaces = 2
max_width = 160
chain_width = 160

CodeLLDB

• CodeLLDB
  • デバッグをサポートするための拡張機能

Rust Test Explorer

• Rust Test Explorer
  • テストをサイドバーから一覧表示して実行できるようになる。

Rust Doc Viewer

• Rust Doc Viewer
  • cargo docで生成されたドキュメントを VSCode 上で表示できるようになる。

crates

• crates
  • 最新のバージョンを編集画面に表示してくれる
  • バージョンのとこをホバーすると選択可能なバージョンを表示してくれる
  • 全てのクレートを一括で最新版にアップデートするコマンドが追加される

Even Better TOML

• Even Better TOML
  • Cargo.tomlで補完が効くようになる。

cargo-edit

• cargo-edit
  • パッケージの追加/削除サブコマンド追加

# インストール
% cargo install cargo-edit

cargo-editの使い方

# パッケージの追加
% cargo add <パッケージ名>
% cargo add <パッケージ名>@<バージョン指定>

# パッケージの追加(開発用)
% cargo add <パッケージ名> --dev

# パッケージのアップグレード
% cargo upgrade <パッケージ名>

# パッケージの削除
% cargo rm <パッケージ名>

cargo-watch

• cargo-watch
  • ファイル変更検知

# インストール
% cargo install cargo-watch

cargo-watchの使い方

# cargo check の自動実行
% cargo watch -x check

# cargo test の自動実行
% cargo watch -x test

# cargo run の自動実行
% cargo watch -x run

# check, test, run の連続実行
% cargo watch -x check -x test -x run

# cargoではないコマンドの自動実行
% cargo watch -- echo Hello world

参考

• Rust をインストール（公式）
• macOSでRustのローカル開発環境を整えるための手順2022
• MacでRustの開発環境を構築する
• 【Rust 入門】macOS と VSCode で環境構築をする方法
• 実践Rustプログラミング入門
• 実践Rust入門[言語仕様から開発手法まで]