Rust 100 Ex 🏃【10/37】 トレイト境界・文字列・Derefトレイト ～トレイトのアレコレ～

前の記事

- [【0】 準備](https://qiita.com/namn1125/items/bd1b4cd028874189a3c1) ← 初回
- ...
- [【9】 Orphan rule (孤児ルール)・演算子オーバーロード・derive ～Empowerment 💪 ～](https://qiita.com/namn1125/items/e565713b423301a80c76) ← 前回
- 【10】 トレイト境界・文字列・Derefトレイト ～ トレイトのアレコレ ～ ← 今回

<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/) 演習第10回になります！

今回の関連ページ

- [4.5. Trait bounds](https://rust-exercises.com/04_traits/05_trait_bounds)
- [4.6. String slices](https://rust-exercises.com/04_traits/06_str_slice)
- [4.7. Deref trait](https://rust-exercises.com/04_traits/07_deref)

# [[04_traits/05_trait_bounds](https://github.com/mainmatter/100-exercises-to-learn-rust/blob/main/exercises/04_traits/05_trait_bounds/src/lib.rs)] トレイト境界

- [4.5. Trait bounds](https://rust-exercises.com/04_traits/05_trait_bounds)

問題はこちらです。

```rust:lib.rs
// TODO: Add the necessary trait bounds to `min` so that it compiles successfully.
//   Refer to the documentation of the `std::cmp` module for more information on the traits you might need.
//
// Note: there are different trait bounds that'll make the compiler happy, but they come with
// different _semantics_. We'll cover those differences later in the course when we talk about ordered
// collections (e.g. BTreeMap).

/// Return the minimum of two values.
pub fn min<T>(left: T, right: T) -> T {
    if left <= right {
        left
    } else {
        right
    }
}
```

コンパイルが通るようにしてほしい問題ですね。早速解いちゃいましょう！

## 解説

今回から **ジェネリクス** が新登場しています。C++でいうところのテンプレートに似たような機能で、C#とかには普通に存在するものですね。今回は関数について存在していますが、例えば動的配列 `Vec<T>` やオプショナル構造体 `Option<T>` 等の構造体、そしてトレイト等様々なところで目にすることになります。

難しい言い方をするとジェネリクスはある意味で、「型を受け取って型を返す写像」と説明されることがあります。この説明も筆者は好きですが、「型のワイルドカード」とかもう少し直感的な捉え方でも良いかなと思ったり。

話が逸れましたが、今回、このジェネリクス関数のコンパイルを通すには「トレイト境界」を設定する必要があります。`T: PartialEq` と書くことによって、 `T` に「ただし `PartialOrd` を実装している型に限る」という制限を設けています。これがトレイト境界[^traitbound]です。

[^traitbound]: ところで、trait boundの和訳として「トレイト境界」とされているらしい？ですが、しばしば[議論の的](https://github.com/rust-lang-ja/book-ja/issues/172)になっているようですね。閑話休題

```diff_rust:lib.rs
- pub fn min<T>(left: T, right: T) -> T {
+ pub fn min<T: PartialOrd>(left: T, right: T) -> T {
    if left <= right {
        left
    } else {
        right
    }
}
```

`T` に `PartialOrd` トレイトが実装されていることが確約されているので、内部で `PartialOrd` が実装された型でしか使えない機能( `<=` )を使用できるようになっています。

トレイト境界はジェネリクス以外のシーンでも、例えばトレイトの定義とかでも登場します(その場合、super trait/sub traitという関係で呼ばれるらしいです)。「トレイトで `self` 変数が使えるのは奇妙に見えるかも...」みたいなことを前回か前々回か言った気がするのですが、トレイト境界はそのモヤモヤを取っ払ってくれる考えかもしれません。ワイルドカードにしたい型に対して、何でもかんでも許すのではなく、ある程度型に求められる条件が絞られるので、トレイト境界が設けられている場合はどんな型が入ってくるかある程度推測できたりします。

# [[04_traits/06_str_slice](https://github.com/mainmatter/100-exercises-to-learn-rust/blob/main/exercises/04_traits/06_str_slice/src/lib.rs)] `String` と `&str`

- [4.6. String slices](https://rust-exercises.com/04_traits/06_str_slice)

問題はこちらです。

```rust:lib.rs
// TODO: Re-implement `Ticket`'s accessor methods. This time return a `&str` rather than a `&String`.

pub struct Ticket {
    title: String,
    description: String,
    status: String,
}

impl Ticket {
    pub fn new(title: String, description: String, status: String) -> Ticket {
        // 省略
    }

    pub fn title(&self) -> &String {
        &self.title
    }

    pub fn description(&self) -> &String {
        &self.description
    }

    pub fn status(&self) -> &String {
        &self.status
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use common::{valid_description, valid_title};
    use std::any::{Any, TypeId};

    #[test]
    fn test_type() {
        let ticket = Ticket::new(valid_title(), valid_description(), "To-Do".to_string());
        // Some dark magic to verify that you used the expected return types
        assert_eq!(TypeId::of::<str>(), ticket.title().type_id());
        assert_eq!(TypeId::of::<str>(), ticket.description().type_id());
        assert_eq!(TypeId::of::<str>(), ticket.status().type_id());
    }
}
```

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

```rust:lib.rs
// TODO: Re-implement `Ticket`'s accessor methods. This time return a `&str` rather than a `&String`.

pub struct Ticket {
    title: String,
    description: String,
    status: String,
}

impl Ticket {
    pub fn new(title: String, description: String, status: String) -> Ticket {
        if title.is_empty() {
            panic!("Title cannot be empty");
        }
        if title.len() > 50 {
            panic!("Title cannot be longer than 50 bytes");
        }
        if description.is_empty() {
            panic!("Description cannot be empty");
        }
        if description.len() > 500 {
            panic!("Description cannot be longer than 500 bytes");
        }
        if status != "To-Do" && status != "In Progress" && status != "Done" {
            panic!("Only `To-Do`, `In Progress`, and `Done` statuses are allowed");
        }

        Ticket {
            title,
            description,
            status,
        }
    }

    pub fn title(&self) -> &String {
        &self.title
    }

    pub fn description(&self) -> &String {
        &self.description
    }

    pub fn status(&self) -> &String {
        &self.status
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use common::{valid_description, valid_title};
    use std::any::{Any, TypeId};

    #[test]
    fn test_type() {
        let ticket = Ticket::new(valid_title(), valid_description(), "To-Do".to_string());
        // Some dark magic to verify that you used the expected return types
        assert_eq!(TypeId::of::<str>(), ticket.title().type_id());
        assert_eq!(TypeId::of::<str>(), ticket.description().type_id());
        assert_eq!(TypeId::of::<str>(), ticket.status().type_id());
    }
}
```
</details>

このままだとテストで落ちてしまいます。指示通り `String` を `str` に直してみましょう。

## 解説

```diff_rust:lib.rs
impl Ticket {
    pub fn new(title: String, description: String, status: String) -> Ticket {
        // 省略
    }

-     pub fn title(&self) -> &String {
+     pub fn title(&self) -> &str {
        &self.title
    }

    // 他も同様

    pub fn description(&self) -> &str {
        &self.description
    }

    pub fn status(&self) -> &str {
        &self.status
    }
}
```

テストでは `std::any::TypeId` 関数を使って `str` のタイプIDを取得し、そのタイプIDと `ticket.title()` などのゲッターが返す型がちゃんと `str` ( `&str` )になっているか確認しているみたいです。

今回から登場した、そしてRustにおいて至るところで見る `&str` は文字列の欠片、文字列スライスと呼ばれるもので、大体はイミュータブル(不変)で文字列の一部を参照するのに使います。深く考える必要はなくて、 `&String` を使うシーンがあれば、 `&str` で置き換えた方が何かと便利と思っておく程度で良いと思います。(個別に考えなければならないシチュエーションを全て洗うのは大変...)

ところで `&String` は `&str` とは異なる型のはずなのに、なぜコンパイルが通るのでしょうか？というのは、次のエクササイズで[Book](https://rust-exercises.com/04_traits/07_deref)にて解説されています。

# [[04_traits/07_deref](https://github.com/mainmatter/100-exercises-to-learn-rust/blob/main/exercises/04_traits/07_deref/src/lib.rs)] Derefトレイト

- [4.7. Deref trait](https://rust-exercises.com/04_traits/07_deref)

「`String` の参照 `&String` が `&str` として振る舞えるのは、 `String` に `Deref<Target = str>` が実装されているからでした！」というのを踏まえた問題になります。トレイトはなんでも可能にしてしまいますね...

```rust:lib.rs
// TODO: whenever `title` and `description` are returned via their accessor methods, they
//   should be normalized—i.e. leading and trailing whitespace should be removed.
//   There is a method in Rust's standard library that can help with this, but you won't
//   find it in the documentation for `String`.
//   Can you figure out where it is defined and how to use it?

pub struct Ticket {
    title: String,
    description: String,
    status: String,
}

impl Ticket {
    pub fn title(&self) -> &str {
        todo!()
    }

    pub fn description(&self) -> &str {
        todo!()
    }
}
```

<details><summary>テストを含めた全体</summary>

```rust:lib.rs
// TODO: whenever `title` and `description` are returned via their accessor methods, they
//   should be normalized—i.e. leading and trailing whitespace should be removed.
//   There is a method in Rust's standard library that can help with this, but you won't
//   find it in the documentation for `String`.
//   Can you figure out where it is defined and how to use it?

pub struct Ticket {
    title: String,
    description: String,
    status: String,
}

impl Ticket {
    pub fn title(&self) -> &str {
        todo!()
    }

    pub fn description(&self) -> &str {
        todo!()
    }
}

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

    #[test]
    fn test_normalization() {
        let ticket = Ticket {
            title: "   A title ".to_string(),
            description: " A description   ".to_string(),
            status: "To-Do".to_string(),
        };

        assert_eq!("A title", ticket.title());
        assert_eq!("A description", ticket.description());
    }
}
```
</details>

## 解説

要は「 `String` 型にはなくて `&str` 型にはあるメソッドをドキュメントから探そう！」という問題です。 `trim` というメソッドを使うと文字列前後の空白文字(改行とかも含む)を除いてくれるので、これを使います。

```rust:lib.rs
impl Ticket {
    pub fn title(&self) -> &str {
        self.title.trim()
    }

    pub fn description(&self) -> &str {
        self.description.trim()
    }
}
```

ちなみに「〇〇にはなくて〇〇の `Deref` トレイト先なら持ってる」で多分この先n回お世話になるのは `Vec<T>` にとっての `&[T]` (スライス) じゃないかなと思います。 `Vec<T>` にしかないメソッド、 `&[T]` 側にあるメソッド、両方存在するので、メソッド名だけ聞いてもドキュメントをみないとどちらのメソッドかすぐにはわからないものがしばしばあるかなと思います。(さらにちなみに配列を扱うのは[第19回](https://qiita.com/namn1125/items/9c49fd4c08f3e61896c7)とだいぶ先だったりします)

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

次の記事: [【11】 Sized トレイト・From トレイト・関連型 ～おもしろトレイトと関連型～](https://qiita.com/namn1125/items/b68990712d379a3d6a49)