プログラミング

Rustプロジェクトの公開ガイド

最終更新： 28/02/2025
1分未満

Rustでプロジェクトを作成し、crates.ioに公開するための完全かつ包括的なガイドを以下に示します。この記事では、Rustプロジェクトを作成し、依存関係を設定し、最終的にcrates.ioに公開する手順を詳細に説明します。

1. Rustのインストール

まず、Rustをインストールする必要があります。Rustは公式のインストーラーであるrustupを使用してインストールできます。以下の手順に従ってください。

関連記事

インストール手順:

  1. Rust公式サイトにアクセスし、「Install Rust」ボタンをクリックします。

  2. コマンドラインで次のコマンドを実行します:

    bash
    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

    このコマンドはrustupをインストールし、必要なツールチェーンをセットアップします。

  3. インストールが完了したら、cargoとrustcが使えることを確認します:

    bash
    rustc --version
cargo --version

2. 新しいRustプロジェクトの作成

次に、Rustで新しいライブラリまたはバイナリプロジェクトを作成します。

プロジェクトの作成:

  1. コマンドラインで新しいRustプロジェクトを作成するために以下のコマンドを実行します:

    bash
    cargo new my_crate --lib

    my_crateはあなたのプロジェクト名です。--libオプションを使うと、ライブラリプロジェクトが作成されます。バイナリプロジェクトを作成したい場合は、--binオプションを使用します。

  2. プロジェクトディレクトリに移動して、作成されたプロジェクトファイルを確認します:

    bash
    cd my_crate

3. プロジェクトの編集

Rustでライブラリやバイナリのコードを編集していきます。

  1. src/lib.rs（ライブラリの場合）またはsrc/main.rs（バイナリの場合）ファイルを開き、コードを編集します。
    例えば、簡単な関数を作成する場合:

    rust
    pub fn hello_world() {
    println!("Hello, world!");
}

  2. 編集が完了したら、プロジェクトをビルドして、正しく動作することを確認します:

    bash
    cargo build

4. Crateの依存関係の設定

プロジェクトに外部ライブラリを追加したい場合は、Cargo.tomlファイルを編集します。例えば、serdeを依存関係として追加する場合は、以下のように記述します:

toml
[dependencies]
serde = "1.0"

依存関係を追加した後、以下のコマンドで依存関係をインストールします:

bash
cargo build

5. プロジェクトのテスト

プロジェクトのテストを行います。Rustは組み込みのテストフレームワークを提供しているので、テストを簡単に書くことができます。

テストコードはtestsディレクトリに配置するか、src/lib.rsの中に#[cfg(test)]アトリビュートを使って記述します。

例えば、次のようにhello_world関数のテストを追加します:

rust
#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_hello_world() {
        hello_world();
    }
}

テストを実行するには、次のコマンドを使用します:

bash
cargo test

6. Crateのバージョン管理

crates.ioに公開する前に、Cargo.tomlファイルのバージョン番号を設定します。一般的に、バージョン番号は次の形式で記述します:

MAJOR.MINOR.PATCH

例えば、最初のバージョンを0.1.0として設定します。

toml
[package]
name = "my_crate"
version = "0.1.0"
authors = ["Your Name "]
edition = "2018"

7. crates.ioアカウントの作成とAPIトークンの取得

crates.ioにプロジェクトを公開するには、crates.ioのアカウントが必要です。以下の手順でアカウントを作成し、APIトークンを取得します。

  1. crates.ioにアクセスし、アカウントを作成します。
  2. アカウント作成後、APIトークンを取得します。このトークンは公開操作に使用されます。
  3. コマンドラインでトークンを設定します: 
    bash
    cargo login

8. Crateの公開

プロジェクトの準備が整ったら、crates.ioに公開するために次のコマンドを実行します:

bash
cargo publish

これで、プロジェクトがcrates.ioにアップロードされ、公開されます。

9. Crateの公開後の管理

公開後は、crates.ioでクレートの管理ができます。バージョンの更新やドキュメントの更新も簡単に行えます。新しいバージョンを公開するには、Cargo.tomlのバージョン番号を更新し、再度cargo publishコマンドを実行します。

10. まとめ

Rustでのクレート作成とcrates.ioへの公開は非常に簡単で、少しの準備で広く利用されるライブラリやツールを他の開発者と共有できます。この記事で説明した手順を順番に実行すれば、Rustでのクレート開発から公開まで一貫して行えます。

最終更新： 28/02/2025
1分未満
Back to top button