Rust 100 Ex 🏃【16/37】 Errorトレイトと外部クレート ～依存はCargo.tomlに全部お任せ！～

前の記事

- [【0】 準備](https://qiita.com/namn1125/items/bd1b4cd028874189a3c1) ← 初回
- ...
- [【15】 Result型 ～Rust流エラーハンドリング術～](https://qiita.com/namn1125/items/698aafaf22ec4bfd1bde) ← 前回
- 【16】 Errorトレイトと外部クレート ～ 依存はCargo.tomlに全部お任せ！ ～ ← 今回

<details><summary>全記事一覧</summary>

- [【0】 準備](https://qiita.com/namn1125/items/bd1b4cd028874189a3c1)
- [【1】 構文・整数・変数](https://qiita.com/namn1125/items/c776768baec89b8a0438)
- [【2】 if・パニック・演習](https://qiita.com/namn1125/items/13870965e8273bc87bce)
- [【3】 可変・ループ・オーバーフロー](https://qiita.com/namn1125/items/4f57f8aede2f5201016f)
- [【4】 キャスト・構造体 (たまにUFCS)](https://qiita.com/namn1125/items/227ed5bbedbb775c5d27)
- [【5】 バリデーション・モジュールの公開範囲 ～ → カプセル化！～](https://qiita.com/namn1125/items/46721cceccbfa9ec3c7a)
- [【6】 カプセル化の続きと所有権とセッター ～そして不変参照と可変参照！～](https://qiita.com/namn1125/items/442de7798d49f777384c)
- [【7】 スタック・ヒープと参照のサイズ ～メモリの話～](https://qiita.com/namn1125/items/780d80e4340f0e34dbf6)
- [【8】 デストラクタ(変数の終わり)・トレイト ～終わりと始まり～](https://qiita.com/namn1125/items/7247edde3b6bd0b85b25)
- [【9】 Orphan rule (孤児ルール)・演算子オーバーロード・derive ～Empowerment 💪 ～](https://qiita.com/namn1125/items/e565713b423301a80c76)
- [【10】 トレイト境界・文字列・Derefトレイト ～トレイトのアレコレ～](https://qiita.com/namn1125/items/9060faee2965f23e0e3d)
- [【11】 Sized トレイト・From トレイト・関連型 ～おもしろトレイトと関連型～](https://qiita.com/namn1125/items/b68990712d379a3d6a49)
- [【12】 Clone・Copy・Dropトレイト ～覚えるべき主要トレイトたち～](https://qiita.com/namn1125/items/c6f34945f331c7229746)
- [【13】 トレイトまとめ・列挙型・match式 ～最強のトレイトの次は、最強の列挙型～](https://qiita.com/namn1125/items/6b2cc31d6a47f9ffaff6)
- [【14】 フィールド付き列挙型とOption型 ～チョクワガタ～](https://qiita.com/namn1125/items/6fe69d1cab6c7936c698)
- [【15】 Result型 ～Rust流エラーハンドリング術～](https://qiita.com/namn1125/items/698aafaf22ec4bfd1bde)
- [【16】 Errorトレイトと外部クレート ～依存はCargo.tomlに全部お任せ！～](https://qiita.com/namn1125/items/9dae7b728fa0668e4102)
- [【17】 thiserror・TryFrom ～トレイトもResultも自由自在！～](https://qiita.com/namn1125/items/d67006a29b7ff5d6148c)
- [【18】 Errorのネスト・慣例的な書き方 ～Rustらしさの目醒め～](https://qiita.com/namn1125/items/705829027661a38e4a4f)
- [【19】 配列・動的配列 ～スタックが使われる配列と、ヒープに保存できる動的配列～](https://qiita.com/namn1125/items/9c49fd4c08f3e61896c7)
- [【20】 動的配列のリサイズ・イテレータ ～またまたトレイト登場！～](https://qiita.com/namn1125/items/6e4dede789c6de97f396)
- [【21】 イテレータ・ライフタイム ～ライフタイム注釈ようやく登場！～](https://qiita.com/namn1125/items/9a1224abf733f29a980a)
- [【22】 コンビネータ・RPIT ～ :dragon: 「 `Iterator` トレイトを実装してるやつ」～](https://qiita.com/namn1125/items/27fe20f2d60803c94357)
- [【23】 `impl Trait` ・スライス ～配列の欠片～](https://qiita.com/namn1125/items/7601d0268293ce7fcf28)
- [【24】 可変スライス・下書き構造体 ～構造体で状態表現～](https://qiita.com/namn1125/items/a9acc7dc2ca7c4c55cc3)
- [【25】 インデックス・可変インデックス ～インデックスもトレイト！～](https://qiita.com/namn1125/items/bd43375362af10ea8b42)
- [【26】 HashMap・順序・BTreeMap ～Rustの辞書型～](https://qiita.com/namn1125/items/a2806cded12fa719a1cb)
- [【27】 スレッド・'staticライフタイム ～並列処理に見るRustの恩恵～](https://qiita.com/namn1125/items/5a4a09172834063268b1)
- [【28】 リーク・スコープ付きスレッド ～ライフタイムに技あり！～](https://qiita.com/namn1125/items/34a0aacd4d40f9234aef)
- [【29】 チャネル・参照の内部可変性 ～Rustの虎の子、mpscと `Rc<RefCell<T>>`～](https://qiita.com/namn1125/items/861e72dbb4b837508948)
- [【30】 双方向通信・リファクタリング ～返信用封筒を入れよう！～](https://qiita.com/namn1125/items/46f03de967d0de46737e)
- [【31】 上限付きチャネル・PATCH機能 ～パンクしないように制御！～](https://qiita.com/namn1125/items/d7ae8a205ee969339401)
- [【32】 `Send`・排他的ロック(`Mutex`)・非対称排他的ロック(`RwLock`) ～真打 `Arc<Mutex<T>>` 登場～](https://qiita.com/namn1125/items/eee890dc8672e975e70c)
- [【33】 チャネルなしで実装・Syncの話 ～考察回です～](https://qiita.com/namn1125/items/cc8bee3871b727e564e3)
- [【34】 `async fn`・非同期タスク生成 ～Rustの非同期入門～](https://qiita.com/namn1125/items/9c32b730a283ad76c891)
- [【35】 非同期ランタイム・Futureトレイト ～非同期のお作法～](https://qiita.com/namn1125/items/c840d48f8f558613ec10)
- [【36】 ブロッキング・非同期用の実装・キャンセル ～ラストスパート！～](https://qiita.com/namn1125/items/39c139da3f1f26264353)
- [【37】 Axumでクラサバ！ ～最終回～](https://qiita.com/namn1125/items/bae492f823fbe60e9974)
- [【おまけ1】 Rustで勘違いしていたこと3選 🏄🌴 【100 Exercises To Learn Rust 🦀 完走記事 🏃】](https://qiita.com/namn1125/items/2a59f486cce30fd2b889)
- [【おまけ2】 【🙇 懺悔 🙇】Qiitanグッズ欲しさに1日に33記事投稿した話またはQiita CLIとcargo scriptを布教する的な何か](https://qiita.com/namn1125/items/8e552694b389c5b13b5e)
</details>

[100 Exercise To Learn Rust](https://rust-exercises.com/) 演習第16回になります！

今回の関連ページ

- [5.9. Error trait](https://rust-exercises.com/05_ticket_v2/09_error_trait)
- [5.10. Packages](https://rust-exercises.com/05_ticket_v2/10_packages)
- [5.11. Dependencies](https://rust-exercises.com/05_ticket_v2/11_dependencies)

# [[05_ticket_v2/09_error_trait](https://github.com/mainmatter/100-exercises-to-learn-rust/blob/main/exercises/05_ticket_v2/09_error_trait/src/lib.rs)] Error トレイト

- [5.9. Error trait](https://rust-exercises.com/05_ticket_v2/09_error_trait)

問題はこちらです。

```rust:lib.rs
// TODO: Implement `Debug`, `Display` and `Error` for the `TicketNewError` enum.
//  When implementing `Display`, you may want to use the `write!` macro from Rust's standard library.
//  The docs for the `std::fmt` module are a good place to start and look for examples:
//  https://doc.rust-lang.org/std/fmt/index.html#write

enum TicketNewError {
    TitleError(String),
    DescriptionError(String),
}

// TODO: `easy_ticket` should panic when the title is invalid, using the error message
//   stored inside the relevant variant of the `TicketNewError` enum.
//   When the description is invalid, instead, it should use a default description:
//   "Description not provided".
fn easy_ticket(title: String, description: String, status: Status) -> Ticket {
    todo!()
}

#[derive(Debug, PartialEq, Clone)]
struct Ticket {
    title: String,
    description: String,
    status: Status,
}

// ...省略...
```

<details><summary>全体</summary>

```rust:lib.rs
// TODO: Implement `Debug`, `Display` and `Error` for the `TicketNewError` enum.
//  When implementing `Display`, you may want to use the `write!` macro from Rust's standard library.
//  The docs for the `std::fmt` module are a good place to start and look for examples:
//  https://doc.rust-lang.org/std/fmt/index.html#write

enum TicketNewError {
    TitleError(String),
    DescriptionError(String),
}

// TODO: `easy_ticket` should panic when the title is invalid, using the error message
//   stored inside the relevant variant of the `TicketNewError` enum.
//   When the description is invalid, instead, it should use a default description:
//   "Description not provided".
fn easy_ticket(title: String, description: String, status: Status) -> Ticket {
    todo!()
}

#[derive(Debug, PartialEq, Clone)]
struct Ticket {
    title: String,
    description: String,
    status: Status,
}

#[derive(Debug, PartialEq, Clone)]
enum Status {
    ToDo,
    InProgress { assigned_to: String },
    Done,
}

impl Ticket {
    pub fn new(
        title: String,
        description: String,
        status: Status,
    ) -> Result<Ticket, TicketNewError> {
        if title.is_empty() {
            return Err(TicketNewError::TitleError(
                "Title cannot be empty".to_string(),
            ));
        }
        if title.len() > 50 {
            return Err(TicketNewError::TitleError(
                "Title cannot be longer than 50 bytes".to_string(),
            ));
        }
        if description.is_empty() {
            return Err(TicketNewError::DescriptionError(
                "Description cannot be empty".to_string(),
            ));
        }
        if description.len() > 500 {
            return Err(TicketNewError::DescriptionError(
                "Description cannot be longer than 500 bytes".to_string(),
            ));
        }

        Ok(Ticket {
            title,
            description,
            status,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use common::{overly_long_description, overly_long_title, valid_description, valid_title};
    use static_assertions::assert_impl_one;

    #[test]
    #[should_panic(expected = "Title cannot be empty")]
    fn title_cannot_be_empty() {
        easy_ticket("".into(), valid_description(), Status::ToDo);
    }

    #[test]
    fn template_description_is_used_if_empty() {
        let ticket = easy_ticket(valid_title(), "".into(), Status::ToDo);
        assert_eq!(ticket.description, "Description not provided");
    }

    #[test]
    #[should_panic(expected = "Title cannot be longer than 50 bytes")]
    fn title_cannot_be_longer_than_fifty_chars() {
        easy_ticket(overly_long_title(), valid_description(), Status::ToDo);
    }

    #[test]
    fn template_description_is_used_if_too_long() {
        let ticket = easy_ticket(valid_title(), overly_long_description(), Status::ToDo);
        assert_eq!(ticket.description, "Description not provided");
    }

    #[test]
    fn display_is_correctly_implemented() {
        let ticket = Ticket::new("".into(), valid_description(), Status::ToDo);
        assert_eq!(format!("{}", ticket.unwrap_err()), "Title cannot be empty");
    }

    assert_impl_one!(TicketNewError: std::error::Error);
}
```
</details>

今回の問題は正直あんまり"旨味"を感じにくい気がします。というのも、自前定義したエラー用の列挙体に `Error` トレイトを実装する必要性が問題内にはないからです。

## 解説

`Error` トレイトは `Debug` トレイトと `Display` トレイトを要求するので、これらを実装することで `Error` トレイトを実装できます。

```rust:lib.rs
use std::error::Error;
use std::fmt;

#[derive(Debug)]
enum TicketNewError {
    TitleError(String),
    DescriptionError(String),
}

use TicketNewError::*;

impl fmt::Display for TicketNewError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let (TitleError(s) | DescriptionError(s)) = self;
        write!(f, "{}", s)
    }
}

impl Error for TicketNewError {}

fn easy_ticket(title: String, description: String, status: Status) -> Ticket {
    let ticket_w = Ticket::new(title.clone(), description, status.clone());

    match ticket_w {
        Ok(ticket) => ticket,
        Err(DescriptionError(_)) => {
            Ticket::new(title, "Description not provided".to_string(), status).unwrap()
        }
        t => t.unwrap(),
    }
}
```

本問題は次問題以降の布石的な感じですね。用意したエラー型が `std::error::Error` を実装してくれていたほうが、エラーレポートの観点で後々便利なので実装しておいた方が良い、というのは確かです...でもやっぱり今回みたいに丁寧に実装することはほぼないんだよなぁ...

# [[05_ticket_v2/10_packages](https://github.com/mainmatter/100-exercises-to-learn-rust/blob/main/exercises/05_ticket_v2/10_packages/src/lib.rs)] パッケージ (クレート群)

- [5.10. Packages](https://rust-exercises.com/05_ticket_v2/10_packages)

問題はこちらです。今回はめずらしく `lib.rs` が準備されておらず、 `lib.rs` を自分で用意して `main.rs` で読み込むという構造になっています。

```rust:main.rs
// This is a `main.rs` file, therefore `cargo` interprets this as the root of a binary target.

// TODO: fix this broken import. Create a new library target in the `src` directory.
//   The library target should expose a public function named `hello_world` that takes no arguments
//   and returns nothing.
use packages::hello_world;

// This is the entrypoint of the binary.
fn main() {
    hello_world();
}
```

なぜ急に「外部のパッケージを読み込む」という問題を解いているかというと、最終的に [`thiserror`](https://docs.rs/thiserror/latest/thiserror/) という便利パッケージを読み込むためですね。

## 解説

`lib.rs` を用意して、必要な関数を書き `pub` で公開します。

```rust:lib.rs
pub fn hello_world() {}
```

今回の問題は、 `lib.rs` と `main.rs` は別モジュール扱いされるという仕組みのお陰で成り立っている部分もありますね。 `lib.rs` 以下ではクレートのルートパスは `crate` なのですが、 `main.rs` から見た `lib.rs` は `Cargo.toml` の `package.name` が参照されるというのは、覚えておくと便利でしょう。

# [[05_ticket_v2/11_dependencies](https://github.com/mainmatter/100-exercises-to-learn-rust/blob/main/exercises/05_ticket_v2/11_dependencies/src/lib.rs)] 外部パッケージの利用

- [5.11. Dependencies](https://rust-exercises.com/05_ticket_v2/11_dependencies)

問題はこちらです。「サードパーティ製のクレートを使ってみよう！」という問題です！

```rust:lib.rs
// TODO: Add `anyhow` as a dependency of this project.
//  Don't touch this import!

// When you import a type (`Error`) from a dependency, the import path must start
// with the crate name (`anyhow`, in this case).
use anyhow::Error;
```

今回も例外的な問題で、編集対象は `lib.rs` ではなく外部依存クレートを管理するところである `Cargo.toml` になります！

```toml:Cargo.toml
[package]
name = "deps"
version = "0.1.0"
edition = "2021"
```

## 解説

`[dependencies]` の項目に `anyhow = "..."` を加えることで、サードパーティクレート `anyhow` が使用可能になります！

```diff_toml:Cargo.toml
[package]
name = "deps"
version = "0.1.0"
edition = "2021"

+ [dependencies]
+ anyhow = "1.0.86"
```

`Cargo.toml` を直接編集するのではなく、 `cargo add` コマンドの使用をおすすめします。というのも、最新版を参照してくれるように書き込んでくれるためです。

```bash:bash
cargo add anyhow
```

VSCodeを使っているならば、 [crates](https://marketplace.visualstudio.com/items?itemName=serayuzgur.crates) という拡張機能もお勧めです。 `Cargo.toml` ファイルを開いてワイルドカードを用いて `anyhow = "*"` のようにバージョンを記載し、横の✅️を押すと最新版をサジェストしてくれます。

ちなみにワイルドカードによるバージョン指定について、面倒ならばそれでも問題はないですが(その代わり `Cargo.lock` もちゃんと管理する必要があります)、なるべく再利用性や再現性を高めたいならしっかり具体的に指定することをオススメします。指定しておかないと後で後悔しがち...

:::note 
**anyhow**

[`anyhow`](https://docs.rs/anyhow/latest/anyhow/)は[`thiserror`](https://docs.rs/thiserror/latest/thiserror/)と対をなすエラーハンドリングのためのクレートです。

thiserrorが丁寧にエラーを扱うためのクレートなら、anyhowはテキトーに(つまり、「とにかく」)エラーを扱うためのクレートです！

anyhow一番最強の構造体は `anyhow::Result<T>` でしょう。`dyn std::error::Erro + 'static` な任意のエラーを、全部統一的に扱えてしまう恐ろしい構造体です...！

`Result` 周りで横着したくなった時は `anyhow::Result` を使ってみてください。飛ぶぞ
:::

では次の問題に行きましょう！

次の記事: [【17】 thiserror・TryFrom ～トレイトもResultも自由自在！～](https://qiita.com/namn1125/items/d67006a29b7ff5d6148c)