Rust 100 Ex 🏃【21/37】 イテレータ・ライフタイム ～ライフタイム注釈ようやく登場！～

前の記事

- [【0】 準備](https://qiita.com/namn1125/items/bd1b4cd028874189a3c1) ← 初回
- ...
- [【20】 動的配列のリサイズ・イテレータ ～またまたトレイト登場！～](https://qiita.com/namn1125/items/6e4dede789c6de97f396) ← 前回
- 【21】 イテレータ・ライフタイム ～ライフタイム注釈登場！～ ← 今回

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

今回の関連ページ

- [6.5. Iter](https://rust-exercises.com/06_ticket_management/05_iter)
- [6.6. Lifetimes](https://rust-exercises.com/06_ticket_management/06_lifetimes)

# [[06_ticket_management/05_iter](https://github.com/mainmatter/100-exercises-to-learn-rust/blob/main/exercises/06_ticket_management/05_iter/src/lib.rs)] イテレータ 2 ( `Iterator` トレイト？ )

- [6.5. Iter](https://rust-exercises.com/06_ticket_management/05_iter)

<!-- ここより前までの演習を含め、forループはIntoIteratorとloopの組み合わせに過ぎないというのはすごいわかりやすいかも -->

問題はこちらです。

```rust:lib.rs
use ticket_fields::{TicketDescription, TicketTitle};

// TODO: Provide an `iter` method that returns an iterator over `&Ticket` items.
#[derive(Clone)]
pub struct TicketStore {
    tickets: Vec<Ticket>,
}

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

#[derive(Clone, Debug, Copy, PartialEq)]
pub enum Status {
    ToDo,
    InProgress,
    Done,
}

impl TicketStore {
    pub fn new() -> Self {
        Self {
            tickets: Vec::new(),
        }
    }

    pub fn add_ticket(&mut self, ticket: Ticket) {
        self.tickets.push(ticket);
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use ticket_fields::test_helpers::{ticket_description, ticket_title};

    #[test]
    fn add_ticket() {
        let mut store = TicketStore::new();

        let ticket = Ticket {
            title: ticket_title(),
            description: ticket_description(),
            status: Status::ToDo,
        };
        store.add_ticket(ticket);

        let ticket = Ticket {
            title: ticket_title(),
            description: ticket_description(),
            status: Status::InProgress,
        };
        store.add_ticket(ticket);

        let tickets: Vec<&Ticket> = store.iter().collect();
        let tickets2: Vec<&Ticket> = store.iter().collect();
        assert_eq!(tickets, tickets2);
    }
}
```

## 解説

いつもなら「〇〇トレイトを実装しよう！」という流れになるところですが、今回は珍しく「トレイトではなく、本体が所有する `iter` メソッドを定義しましょう！」という問題になっています。

まぁ今回もトレイトが全く関わっていないわけではなく、「返り値の型が [`Iterator`](https://doc.rust-lang.org/std/iter/trait.Iterator.html) トレイトを実装している」という特徴があり、特に次回以降解決する部分のようです(コメントアウトしている関数のシグネチャがその伏線)。

```rust:lib.rs
impl TicketStore {
    // ...省略...

    // pub fn iter(&self) -> impl Iterator<Item = &Ticket> {
    pub fn iter(&self) -> std::slice::Iter<'_, Ticket> {
        self.tickets.iter()
    }
}
```

[Book](https://rust-exercises.com/06_ticket_management/05_iter) の方に書かれている内容ですが、要は今回の目的は「所有権を奪わず、アイテムの **参照** をイテレートしたい」というものです。そのための手段が2つ紹介されています。

- `TicketStore` ではなくその参照 `&TicketStore` の方に `IntoIterator` を実装する
- 参照を要素とするイテレータを返す

今回は2つ目のアプローチというわけで、そしてイテレータであることを表す `Iterator` トレイトを実装するのではなく、「そういう(参照の)イテレータを返す」だけですから、別にこの目的専用のトレイトはないのでしょう。慣例的に `.iter()` メソッドとしています。

今回の問題では、内部で所有している動的配列である `tickets` にある [スライスのメソッド `.iter()`](https://doc.rust-lang.org/std/vec/struct.Vec.html#method.iter) の返り値をそのまま返しています。 `Vec` の `Deref` 先がスライスなのでこの呼び出しが可能です。以上より、スライスの `.iter()` の返り値型 `std::slice::Iter<'a, T>` がそのまま `TicketStore::iter` の返り値型になっています。

`'_` や `'a` という表記方法がこの章まで来て(ようやく)出てきました。そう、これがライフタイム注釈というもので、次のエクササイズの話題のようです。

# [[06_ticket_management/06_lifetimes](https://github.com/mainmatter/100-exercises-to-learn-rust/blob/main/exercises/06_ticket_management/06_lifetimes/src/lib.rs)] ライフタイム注釈

- [6.6. Lifetimes](https://rust-exercises.com/06_ticket_management/06_lifetimes)

問題はこちらです。

```rust:lib.rs
use ticket_fields::{TicketDescription, TicketTitle};

// TODO: Implement the `IntoIterator` trait for `&TicketStore` so that the test compiles and passes.
#[derive(Clone)]
pub struct TicketStore {
    tickets: Vec<Ticket>,
}

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

#[derive(Clone, Debug, Copy, PartialEq)]
pub enum Status {
    ToDo,
    InProgress,
    Done,
}

impl TicketStore {
    // ...省略...

    pub fn iter(&self) -> std::slice::Iter<Ticket> {
        self.tickets.iter()
    }
}
```

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

```rust:lib.rs
use ticket_fields::{TicketDescription, TicketTitle};

// TODO: Implement the `IntoIterator` trait for `&TicketStore` so that the test compiles and passes.
#[derive(Clone)]
pub struct TicketStore {
    tickets: Vec<Ticket>,
}

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

#[derive(Clone, Debug, Copy, PartialEq)]
pub enum Status {
    ToDo,
    InProgress,
    Done,
}

impl TicketStore {
    pub fn new() -> Self {
        Self {
            tickets: Vec::new(),
        }
    }

    pub fn add_ticket(&mut self, ticket: Ticket) {
        self.tickets.push(ticket);
    }

    pub fn iter(&self) -> std::slice::Iter<Ticket> {
        self.tickets.iter()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use ticket_fields::test_helpers::{ticket_description, ticket_title};

    #[test]
    fn add_ticket() {
        let mut store = TicketStore::new();

        let ticket = Ticket {
            title: ticket_title(),
            description: ticket_description(),
            status: Status::ToDo,
        };
        store.add_ticket(ticket);

        let ticket = Ticket {
            title: ticket_title(),
            description: ticket_description(),
            status: Status::InProgress,
        };
        store.add_ticket(ticket);

        let tickets: Vec<&Ticket> = store.iter().collect();
        let tickets2: Vec<&Ticket> = (&store).into_iter().collect();
        assert_eq!(tickets, tickets2);
    }
}
```
</details>

## 解説

前エクササイズで取り組まなかった `&TicketStore` の方に `Iterator` を実装する問題です。先のエクササイズでは `'_` としてとりあえず考慮しなくて？良かったのですが、今回は Lifetime elision 、つまりライフタイム省略が効かないパターンらしく、考慮する必要があるみたいです。

```rust:lib.rs
impl<'a> IntoIterator for &'a TicketStore {
    type Item = &'a Ticket;
    type IntoIter = std::slice::Iter<'a, Ticket>;

    fn into_iter(self) -> Self::IntoIter {
        self.tickets.iter()
    }
}
```

ライフタイム自体は [第8回](https://qiita.com/namn1125/items/7247edde3b6bd0b85b25) や [第12回](https://qiita.com/namn1125/items/c6f34945f331c7229746) にて軽く関連した話が出てきていましたが、表記という形でちゃんと向き合うのは今回が初めてですね。

本問題での `'a` の使われ方はおおよそ次のような感じです(うーん間違ってるかも...)。

- `impl<'a>` の `'a`: `'a` というライフタイムパラメータを使いますよという宣言。ジェネリクスの型パラメータと同じと考えるとわかりやすい
- `&'a TicketStore`, `&'a Ticket` の `'a`: ライフタイム `'a` の間は生きていることが保証された参照、の意味
- `std::slice::Iter<'a, Ticket>` の `'a`: ライフタイム `'a` の間だけ生きている構造体

こんな後半になってようやくライフタイムが登場していることについて、筆者の直感と100 Exercisesが一致しているからかなぁとか思ったりします。

というのも、正直Rustの習得において **ライフタイムと常に向き合う必要はありません** 。Rust言語自体の仕様策定に関わりたいとかならともかく、日々のコーディングではコンパイラに怒られた時だけ考えれば良いです。ですから筆者もライフタイムは曖昧にしか理解していません。

ライフタイムで何かつまずいたら、次の順番で解決を試みるのがお勧めです。

1. `Clone` トレイトを実装しちゃダメなのか検討する
2. もし効率面の問題ではなく借用等の問題から `Clone` トレイトを使えない、みたいな場合は、おそらく所有権の所在が不明である等が原因として考えられるので、 [`Rc`](https://doc.rust-lang.org/std/rc/struct.Rc.html) や [`Arc`](https://doc.rust-lang.org/std/sync/struct.Arc.html) が使えないかを検討する
3. もし効率面からなんとしても参照のまま複雑な構造体を扱いたい、という段になったら、ライフタイム注釈をつける

ライフタイム注釈を真正面から向き合わなくてもなんとかなるための考えや道具がRustにはいくつかあるわけです。今回は珍しく必要なシーン(実体ではなく参照を返したい)だったからようやく登場したという感じなのだと思います。普段は忘れていて大丈夫です！

:::note 
**ライフタイムに依存した構造体**

おそらく `Iter<'a, T>` は要素実体への参照を保持していると考えられます。しかし名前には `&` が含まれず、「ライフタイム `'a` だけ存在していられる」以上の情報は含まれていないです。どうやったらこんな感じの構造体が書けるのでしょうか...？フィールドに参照があれば良い...？難しくはないですが、軽く確認してみたいと思います。[こんな感じ](https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=2d84793ecedff131918e4dfc8bcd2641)でしょうかね。

```rust:Rust
#[derive(Debug)]
struct Hoge<'a, T> {
    my_slice: &'a [T],
}

fn main() {
    let h: Hoge<'_, u32>;

    {
        let v = vec![1, 2, 3, 4, 5];
        
        h = Hoge {
            my_slice: v.as_slice(),
        };
        
        println!("{:?}", h);
    }
    
    // println!("{:?}", h); // ここで参照するとコンパイルエラー！
}
```

ついでに [`PhantomData`](https://doc.rust-lang.org/std/marker/struct.PhantomData.html) (幽霊型)という構造体を使って、ちょっと[遊んでみました](https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=835fc4daddf05918b57779df61b6e738)。表記上は参照を含みますが、この構造体はなんと実質 **なんのデータも持たない** のに、 **ライフタイムパラメータだけはバッチリ有効** という存在になっています！

```rust:Rust
use std::marker::PhantomData;

struct Hoge;

#[derive(Debug)]
struct ResourceRelatedToHoge<'a>(PhantomData<&'a Hoge>);

impl<'a> ResourceRelatedToHoge<'a> {
    fn new(_: &'a Hoge) -> Self {
        Self(PhantomData)
    }
}

fn main() {
    let r: ResourceRelatedToHoge<'_>;
    {
        let hoge = Hoge;
        r = ResourceRelatedToHoge::new(&hoge);
        
        println!("{:?}", r);
    }
    // println!("{:?}", r); // ここで参照するとコンパイルエラー！
}
```

Rustで変わったことをしたい時(例えば筆者が実際に経験した例だと、RAII的に管理しなければならないWin32APIの某を扱う時など)に、「参照は要らないけど他の構造体に依存したい」という時は上記のように `PhantomData` 型を使うといい感じにできます！小ネタでした。
:::

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

次の記事: [【22】 コンビネータ・RPIT ～ \U0001F409 「 `Iterator` トレイトを実装してるやつ」～](https://qiita.com/namn1125/items/27fe20f2d60803c94357)