Rust

Rust パッケージガイドライン

Rust は、Mozilla Research がスポンサーとなっている、汎用的なマルチパラダイム・コンパイル型プログラミング言語である。Rust は、"安全で、並行処理が可能で、実用的な言語" として設計されており、純粋関数型、命令型-手続き型、オブジェクト指向型のスタイルをサポートしている。Rust の目標は、高度に並行かつ高度に安全なシステムを作成し、大規模なプログラミングを行うのに適した言語となることです。そのため、安全性、メモリレイアウトの制御、並行処理に重点を置いた機能セットになっています。Rust の性能は、慣用的な C++ の性能に匹敵します。

ライブラリ

Rust コアライブラリ

Rust Core Library は何にも依存しない Rust 標準ライブラリの基礎となるライブラリです。LLVM と直接通じることで、ハードウェアに囚われないプラットフォームとして Rust を使うことができます。LLVM との緊密な統合により、Clang でコンパイルされた C アプリケーションよりも高い性能を発揮することができ、libcore で設計された Rust ソフトウェアは C よりも低レイヤーを扱うことができます。組み込み環境向けのソフトウェアを開発している場合、#![no_std] で標準ライブラリを省くことでコアライブラリだけを使うことができ、バイナリサイズを小さく、高い性能を発揮させることが可能です。ただし、#![no_std] を使用すると Rust コミュニティから取得することができる膨大なソフトウェアに制限がかかるため、大抵のライブラリは標準ライブラリを必要としています。

Rust 標準ライブラリ

Rust Standard Library は移植性の高い Rust ソフトウェアによって構成された便利な高水準の抽象ライブラリです。Vec, Iterator, Option, Result, String 型や、基本的なメソッド、大量の標準マクロ、I/O やマルチスレッドのサポート、Box によるヒープメモリ確保などの便利な機能、その他、コアライブラリに存在しない高度な機能が多数存在します。

リリースサイクル

Rust は Firefox のリリースサイクルと同じように6週間ごとに定期的にリリースされます。新しいリリースが出るたびに、コアライブラリや標準ライブラリは改善され、対応プラットフォームが新しく増えたりパフォーマンスが向上したり、あるいは新しい機能の安定化が行われます。

インストール

Rust をインストールする主な方法は次の2つです。

ネイティブインストール。Rust で作成されたソフトウェアの実行またはインストールにのみ Rust を使用する場合に推奨されます。
Rustup のインストール。Rust で何かをプログラムする場合にお勧めします。

ネイティブのインストール方法

Rust の最新安定版をインストールするには、rust パッケージをインストールしてください。rustc コンパイラと Cargo がインストールされます。

Rust コンパイラの開発バージョンも利用できます。事前に構築された汎用バイナリの場合は rust-nightly-bin^AUR、システムライブラリを使用してコンパイラを構築する場合は rust-git^AUR を使って下さい。

Rustup によるインストール方法

Rust でソフトウェアを開発するときに、公式に推奨されている Rust のインストール方法は Rustup ツールチェインマネージャを使用する方法です (Rustup は Rust で書かれています)

ソフトウェアリポジトリに存在するスタンドアロンな Rust を使用しないで、Rustup ツールチェインマネージャを使用する利点として、複数のプラットフォーム (Windows, Mac, Android) やアーキテクチャ (x86, x86_64, arm) 用に複数のツールチェイン (stable, beta, nightly) をインストールすることができる点が挙げられます。

上流のインストールスクリプト

Rustup は、の公式 Web ページから手動でダウンロードしてインストールすることもできます。

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs -o rust.sh としてファイルをダウンロードします。そのあと、less ./rust.sh でファイルの内容を確認した上で、./rust.sh でスクリプトを実行してください。スクリプトはログインシェルの設定ファイルの PATH のみ変更します。一度ログアウトしてからログインしなおすか source $HOME/.cargo/env を実行する必要があります。その後 rustup を更新するには rustup self update を実行するだけです。

このスクリプトは、デフォルトでデフォルトのツールチェーン (rust パッケージで使用されるツールチェーン) をインストールしてアクティブ化するため、Rust の使用を開始するために手動でインストールする必要はありません。

警告: Rustup のドキュメントに書かれている、curl some-url を実行するのは、セキュリティ上のリスクがあると考えられます。ダウンロード中に壊させるかもしれない、未知のソースコードを実行するからです。従って、実行する前に、手動でダウンロードし内容を確認することが推奨されます。

ノート: rustup コマンドを実行する前に PATH に $HOME/.cargo/bin を追加してください。

Arch Linux パッケージ

rustup は公式リポジトリからインストールすることもできます。公式リポジトリからインストールした場合 rustup self update は使用できないので注意してください。pacman で直接パッケージをアップデートする必要があります。

この方法だと、Rust のバイナリが ~/.cargo/bin ではなく /usr/bin にあり、PATH に別のディレクトリを加えなくてよい利点があります。

ノート: 既定では、rustup パッケージをインストールしても、ツールチェインはインストールされません。かわりに、/usr/bin/rustup コマンドから /usr/bin/rustc や /usr/bin/cargo など一般的なバイナリにシンボリックリンクが張られます。次に述べるように、Rust コマンドを動作させるには、利用者が手動でツールチェインをインストールする必要があります。

ツールチェインをインストールするには、stable か nightly のどちらのバージョンを使用するか rustup に指定する必要があります:

$ rustup default stable

使い方

stable、beta、nightly や 1.23.0 などのツールチェインを手動でインストールする必要があったり、また、他のツールチェインを使用したりテストするときには次のコマンドを入力します:

$ rustup toolchain install toolchain

すると、Rust コマンドを rustup run toolchain command として実行できます。これらのコマンドを直接実行するには、ツールチェインをアクティベートする必要があります:

$ rustup default toolchain

rustc -V を使って rust のバージョンを確認してください:

$ rustc -V

rustc 1.26.0 (a77568041 2018-05-07)

ノート: Rustup は rust パッケージに含まれている Rust コマンドのうち、rustfmt や rls などいくつかをインストールしません。これにより、Rust メンテナが nightly チャンネルを rustfmt/rls が壊れていても提供できるようになります。これらをインストールするには、個別に rustup component add rls および rustup component add rustfmt を実行します。また、実行することで、rustfmt/rls が壊れる場合、nightly チャンネルの更新を保留するようになります。

ノート: Rust 自身にはリンカはないので、リンカが別途インストールされてなければなりません。リンカとして例えば gcc をインストールすることができます。リンカがないと Rust は error: linker `cc` not found. とエラーを出力します。

インストールのテスト

以下のようなシンプルなプログラムをビルドして、Rust が正しくインストールされていることを確認してください:

~/hello.rs

 fn main() {
     println!("Hello, World!");
 }

rustc でコンパイルして実行することができます:

$ rustc hello.rs && ./hello

Hello, World!

クロスコンパイル

rustup を使う

rustup を使うことで簡単にクロスコンパイルができます。rustup は多数のクロスコンパイルターゲットに対応しています。対応しているプラットフォームの完全なリストは rustup target list を実行することで確認できます。

例えば、gnu コンパイラを使って Windows 用にコンパイルする stable チャンネルの rust をインストールしたい場合、以下を実行:

$ rustup install stable-x86_64-pc-windows-gnu

上記のコマンドでは、コンパイル先のアーキテクチャ用の rust とツールしかインストールされません。場合によってはクロスコンパイルするのに追加でツールが必要になる可能性があります。

Windows

このセクションでは、$ARCH がターゲットのアーキテクチャです (x86_64 または i686)。

mingw64-w64-gcc-base^AUR^{[リンク切れ: パッケージが存在しません]} と mingw-w64-gcc と wine をインストール。
rustup を使っている場合、rustup install stable-$ARCH-pc-windows-gnu と rustup target add $ARCH-pc-windows-gnu を実行することで rust と標準ライブラリをインストールできます。rustup を使っていない場合、rustlib ディレクトリ (rust-nightly-bin^AUR を使用する場合は /usr/local/lib/rustlib、公式の rust パッケージを使用する場合は /usr/lib/rustlib) に Windows 用の Rust の標準ライブラリのコピーをインストールします。一番簡単な方法は、ターゲットとするアーキテクチャの Windows 用の Rust インストーラーをダウンロードして、Wine を使ってインストール (wine start my-rust-installer.msi) してから rustlib ディレクトリにコピー $INSTALL_DIR/bin/rustlib/$ARCH-pc-windows-gnu する方法です。
最後に、cargo の設定ファイルに以下を追加して MinGW-w64 の gcc/ar のパスを cargo に指定します:

~/.cargo/config

[target.$ARCH-pc-windows-gnu]
linker = "/usr/bin/$ARCH-w64-mingw32-gcc"
ar = "/usr/$ARCH-w64-mingw32/bin/ar"

cargo に --target $ARCH-pc-windows-gnu と指定することで Windows 向けのクロスコンパイルができます:

$ # Build
$ cargo build --release --target "$ARCH-pc-windows-gnu"
$ # Run unit tests under wine
$ cargo test --target "$ARCH-pc-windows-gnu"

非公式パッケージ

非公式の archlinuxcn リポジトリには i686, ARM, ARMv7, Windows 32, Windows 64 向けの rust-nightly と Rust 標準ライブラリが含まれています。パッケージをインストールすればクロスコンパイルができます。ただし、ARM のツールチェインは自分で用意する必要があります。32ビット版の Windows を対象にビルドする場合、実行するのに libgcc_s_dw2-1.dll が必要になります。

Cargo

Rust のパッケージマネージャである Cargo は rust パッケージに付属しています。ナイトリー版は AUR の cargo-nightly-bin^AUR でインストールできます。rustup を使用している場合、Cargo は既にインストールされています。

Cargo は Rust プロジェクトの依存関係を宣言することができるようにするツールであり、それによってビルドがいつでも通ることが保証されます。

使用方法

Cargo を使って新しいプロジェクトを作成するには:

$ cargo new hello_world --bin

ノート: Cargo がプロジェクトをコンパイルするのに必要なメタデータを全て含めたマニフェストファイルである Cargo.toml ファイルを Cargo は使用します:

Cargo.toml

[package]
name = "hello_world"
version = "0.1.0"
authors = ["Your Name <you@example.com>"]

ネイティブ CPU プラットフォームに最適化

Cargo に CPU プラットフォームに最適なコードで常にコンパイルするように指示するには、~/.cargo/config にフラグを追加します。生成されたバイナリは他のコンピュータで使用するために配布することはできません。また、将来 CPU を変更しようとすると、自分のシステムで失敗する可能性があります。

インストールでデフォルトで使用されるターゲットプラットフォームを確認します。

$ rustup toolchain list

stable-x86_64-unknown-linux-gnu (default)

この例では、x86_64-unknown-linux-gnu プラットフォームで stable rust を使用しています。

~/.cargo/config

[target.x86_64-unknown-linux-gnu]
rustflags = ["-C", "target-cpu=native"]

sccache

sccache を使うと中間生成物をキャッシュすることで、前回のコンパイル時から変化しない部分の再コンパイル時間を省きます。sccache パッケージでインストールできます。

Cargo で利用するには以下の方法があります。 RUSTC_WRAPPER 環境変数を設定することで一時的に sccache を利用できます:

RUSTC_WRAPPER=sccache cargo build

常に利用するようにするには、~/.cargo/config に以下の設定を加えます:

~/.cargo/config

[build]
rustc-wrapper = "sccache"

IDE のサポート

ツール

Rust プロジェクトの推奨ツールについては、https://www.rust-lang.org/tools を参照してください。

RLS

RLS は Rust 用の Language Server Protocol を提供し, IDE やエディタなどのツールに Rust プログラムに関する情報を提供します。goto definition シンボル検索、再フォーマット、コード補完などの機能をサポートし、名前の変更とリファクタリングを可能にします。

RLS は rust パッケージに含まれています。rustup を使用して RLS をインストールするには

$ rustup component add rls rust-analysis rust-src

rust-analyzer

rust-analyzer は RLS を置き換えることを意図した Rust 用の実験的な言語サーバプロトコル実装です。

rust-analyzer パッケージとして入手でき、最新の Git バージョンは rust-analyzer-git^AUR として入手できます。

rust-analyzer は標準ライブラリのソースコードを必要とします。これが存在しない場合、rust-analyzer は、rustup を使用して自動的にインストールを試みます。rustup を使用してソースコードを手動でインストールするには、次のコマンドを実行します。

$ rustup component add rust-src

Racer

Racer 自動補完エンジンは Rust の自動補完が必要な際に現在最も優れている選択肢です。ただし、Racer を使うには Rust のソースコードのコピーをインストールする必要があります。入手する方法は複数存在します:

rustup を使う: rustup component add rust-src。
AUR を使う: rust-src^AUR^{[リンク切れ: パッケージが存在しません]} または rust-nightly-src^AUR。AUR を使用する場合は RUST_SRC_PATH 環境変数を設定してください。

ソースコードをインストールしたら、rust-racer パッケージをインストールするか、Cargo を使って Racer をインストールすることができます:

$ cargo install racer

Clippy

Clippy は Rust のナイトリービルドに存在するコンパイラプラグイン機能を利用して、様々なエラーや慣習的な警告を検出する文法チェックを行います。安定版の Rust コンパイラでコンパイルするときに clippy を使うことはできません。Clippy は cargo でインストールできます:

$ cargo install clippy

Rustfmt

Rustfmt は公式のスタイルガイドラインに従って Rust コードをフォーマットするツールです。

Rustfmt は rust パッケージに含まれています。rustup を使用してインストールするには

$ rustup component add rustfmt

エディタ

Atom

Atom はプラグインで Rust 言語をサポートします: language-rust と linter-rust

Emacs

Emacs の Rust サポートは公式の rust-mode プラグインか emacs-rust-mode^AUR^{[リンク切れ: パッケージが存在しません]} パッケージで有効にできます。

GNOME Builder

GNOME Builder の Rust サポートは、Language Server Protocol を使って実現されています。デフォルトでは rust-analyzer を使用します。Rust のソースと一緒にインストールするだけです。

Helix

Helix エディタは Rust で書かれており、Rust 言語サーバープロトコルが含まれています。Helix は Neovim と Kakoune からインスピレーションを受けています。

Kate

Kate の Rust サポートは kate パッケージによってデフォルトでインストールされますが、追加の設定も必要です。まず、パッケージ rust-racer をインストールします。次に、Rust のソースを取得します。

rustup:rustup component add rust-src
または AUR:rust-src-git^AUR または rust-nightly-src^AUR から、この場合は RUST_SRC_PATH 環境変数を設定する必要があります。

次に、設定 -> BAR_Kate 設定をクリックして、Application_BAR_Plugins に移動して Rust code completion をチェックすると、左側のサイドバーに Application_BAR_Rust コード補完が表示されるので、そこに移動して $HOME/.rustup/toolchains/stable-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/src に Rust source tree の場所 を割り当てます。 Rust ソースを rustup でインストールした場合。

IntelliJ IDEA

IntelliJ IDEA には Rust プラグインが存在します。CLion でも同じプラグインが使えます。ツールチェインを設定するときは rustup を使ってソースをダウンロード (rustup component add rust-src) して、ツールチェインのディレクトリとして ~/.rustup/toolchains/<your toolchain>/bin を選択してください。

Visual Studio Code

VSCode の Rust のサポートは Rust 拡張をインストールすることで得られます。

Vim

Rust の Vim サポートは、公式 [1] プラグインを介して取得できます。このプラグインは、ファイルの検出、シンタックスハイライト、フォーマット、シンタックスチェックプラグイン Syntastic のサポートを提供します。coc (https://github.com/neoclide/coc-rls coc.rls) や YouCompleteMe のように、多くの補完エンジンが Rust をサポートしています。

参照