Rust 100 Ex 🏃【2/37】 if・パニック・演習

前の記事

- [【0】 準備](https://qiita.com/namn1125/items/bd1b4cd028874189a3c1)
- [【1】 構文・整数・変数](https://qiita.com/namn1125/items/c776768baec89b8a0438) ← 前回
- 【2】 if・パニック・演習 ← 今回

<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/) 演習第2回になります！今回はif式について、パニックについてと、ここまでをまとめた演習、という題目になっています！

今回の関連ページ

- [2.3. Branching: if/else](https://rust-exercises.com/02_basic_calculator/03_if_else)
- [2.4. Panics](https://rust-exercises.com/02_basic_calculator/04_panics)
- [2.5. Factorial](https://rust-exercises.com/02_basic_calculator/05_factorial)

では行きましょう！

# [[02_basic_calculator/03_if_else](https://github.com/mainmatter/100-exercises-to-learn-rust/tree/main/exercises/02_basic_calculator/03_if_else/src/lib.rs)] if式

- [2.3. Branching: if/else](https://rust-exercises.com/02_basic_calculator/03_if_else)

問題はこちらです。

```rust:lib.rs
/// Return `true` if `n` is even, `false` otherwise.
fn is_even(n: u32) -> bool {
    todo!()
}

// テスト省略
```

<details><summary>テスト込みver</summary>

```rust:lib.rs
/// Return `true` if `n` is even, `false` otherwise.
fn is_even(n: u32) -> bool {
    todo!()
}

#[cfg(test)]
mod tests {
    use crate::is_even;

    #[test]
    fn one() {
        assert!(!is_even(1));
    }

    #[test]
    fn two() {
        assert!(is_even(2));
    }

    #[test]
    fn high() {
        assert!(!is_even(231));
    }
}
```
</details>

`n` が偶数なら `true` を、 `n` が奇数なら `false` をそれぞれ返せというものです。

## 解説

Rustであることを忘れ、ifを使って愚直に書いてみるとこんな感じでしょうか？

```rust:Rust
fn is_even(n: u32) -> bool {
    let result;

    if n % 2 == 0 {
        result = true;
    } else {
        result = false;
    }

    return result;
}
```

しかしなんとも色々ツッコミたいソースコードです。良い機会ですので[Clippy](https://github.com/rust-lang/rust-clippy)というリンターツールを使ってみたいと思います。

```bash:コマンド
cargo clippy
```

```bash:出力
    Checking if_else v0.1.0 (/path/to/100-exercises-to-learn-rust/exercises/02_basic_calculator/03_if_else)
warning: function `is_even` is never used
 --> exercises/02_basic_calculator/03_if_else/src/lib.rs:2:4
  |
2 | fn is_even(n: u32) -> bool {
  |    ^^^^^^^
  |
  = note: `#[warn(dead_code)]` on by default

warning: unneeded `return` statement
  --> exercises/02_basic_calculator/03_if_else/src/lib.rs:11:5
   |
11 |     return result;
   |     ^^^^^^^^^^^^^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_return
   = note: `#[warn(clippy::needless_return)]` on by default
help: remove `return`
   |
11 -     return result;
11 +     result
   |

warning: unneeded late initialization
 --> exercises/02_basic_calculator/03_if_else/src/lib.rs:3:5
  |
3 |     let result;
  |     ^^^^^^^^^^^
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_late_init
  = note: `#[warn(clippy::needless_late_init)]` on by default
help: declare `result` here
  |
5 |     let result = if n % 2 == 0 {
  |     ++++++++++++
help: remove the assignments from the branches
  |
6 ~         true
7 |     } else {
8 ~         false
  |
help: add a semicolon after the `if` expression
  |
9 |     };
  |      +

warning: this if-then-else expression assigns a bool literal
 --> exercises/02_basic_calculator/03_if_else/src/lib.rs:5:5
  |
5 | /     if n % 2 == 0 {
6 | |         result = true;
7 | |     } else {
8 | |         result = false;
9 | |     }
  | |_____^ help: you can reduce it to: `result = n % 2 == 0;`
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_bool_assign
  = note: `#[warn(clippy::needless_bool_assign)]` on by default

warning: `if_else` (lib) generated 4 warnings (run `cargo clippy --fix --lib -p if_else` to apply 2 suggestions)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.10s
```

１つ目の `warning: function 'is_even' is never used` は無視してしまって構わないです。

- `unneeded 'return' statement`
    - Rustは **式指向言語** ですから関数の最後の `return` は不要です
- `unneeded late initialization`
    - 同じく、式指向言語のため、 **if構文も式** ([Exercises内での解説](https://rust-exercises.com/02_basic_calculator/03_if_else#ifelse-is-an-expression)) ですから `result` の初期化を各節で行う必要はありません

というわけで<font color="gray">(最後のを見なかったことにして)</font>ここまでを踏まえるとこんな感じに直せます！

```rust:lib.rs
fn is_even(n: u32) -> bool {
    if n % 2 == 0 {
        true
    } else {
        false
    }
}
```

<details><summary>冗長な書き方</summary>

```rust:lib.rs
fn is_even(n: u32) -> bool {
    let result = if n % 2 == 0 {
        true
    } else {
        false
    };

    result
}
```
</details>

- ifは式なので `result` に返り値を束縛できます (冗長な書き方として折りたたんでいます)
- 関数は最後に評価された値を返すので、そもそも `result` への束縛は要らないことに気づきます

まとめると、上記コードにより関数の返り値はif式評価後の値となり、`n` の偶奇判定を返せました！

<details><summary>... :thinking: ... :bulb: :astonished: </summary>

```bash:コマンドと出力
$ cargo clippy
    Checking if_else v0.1.0 (/path/to/100-exercises-to-learn-rust/exercises/02_basic_calculator/03_if_else)
warning: function `is_even` is never used
 --> exercises/02_basic_calculator/03_if_else/src/lib.rs:2:4
  |
2 | fn is_even(n: u32) -> bool {
  |    ^^^^^^^
  |
  = note: `#[warn(dead_code)]` on by default

warning: this if-then-else expression returns a bool literal
 --> exercises/02_basic_calculator/03_if_else/src/lib.rs:3:5
  |
3 | /     if n % 2 == 0 {
4 | |         true
5 | |     } else {
6 | |         false
7 | |     }
  | |_____^ help: you can reduce it to: `n % 2 == 0`
  |
  = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_bool
  = note: `#[warn(clippy::needless_bool)]` on by default

warning: `if_else` (lib) generated 2 warnings (run `cargo clippy --fix --lib -p if_else` to apply 1 suggestion)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.12s
```
</details>

```rust:Rust
fn is_even(n: u32) -> bool {
    n % 2 == 0
}
```

そもそも**if式要らないじゃん**...！if式の問題だと思って先入観に囚われていました...

ちなみに[模範解答](https://github.com/mainmatter/100-exercises-to-learn-rust/blob/solutions/exercises/02_basic_calculator/03_if_else/src/lib.rs)の方もif式は使ってないです。こういう問題にしたのはわざと？

こういう時Clippyは偉大です...！

# [[02_basic_calculator/04_panics](https://github.com/mainmatter/100-exercises-to-learn-rust/tree/main/exercises/02_basic_calculator/04_panics/src/lib.rs)] パニック

- [2.4. Panics](https://rust-exercises.com/02_basic_calculator/04_panics)

問題はこちらです。長いですが解くのに必要な情報を含むためテスト部分まで載せます。

```rust:lib.rs
/// Given the start and end points of a journey, and the time it took to complete the journey,
/// calculate the average speed of the journey.
fn speed(start: u32, end: u32, time_elapsed: u32) -> u32 {
    // TODO: Panic with a custom message if `time_elapsed` is 0

    (end - start) / time_elapsed
}

#[cfg(test)]
mod tests {
    use crate::speed;

    #[test]
    fn case1() {
        assert_eq!(speed(0, 10, 10), 1);
    }

    #[test]
    // 👇 With the `#[should_panic]` annotation we can assert that we expect the code
    //    under test to panic. We can also check the panic message by using `expected`.
    //    This is all part of Rust's built-in test framework!
    #[should_panic(expected = "The journey took no time at all, that's impossible!")]
    fn by_zero() {
        speed(0, 10, 0);
    }
}
```

まず前提として、 `speed` 関数は[0割り除算が生じるとパニックになります](https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=36e5ddbe3b3f741dfa9f74c956622bac)。それ自体は良いのですがその時はテスト側で指定している `The journey took no time at all, that's impossible!` というカスタムメッセージを出してほしいようです。

:::note info
**Rust Playground**

https://play.rust-lang.org/

Exercisesの方で紹介されていたのでこちらでも紹介しておきます。[Wandbox](https://wandbox.org/)や[ideone](https://www.ideone.com/)、[TS playground](https://www.typescriptlang.org/play)みたいなオンラインエディタのRust特化版です！

Wandbox同様パーマリンクでソースコードを共有できるので、プロジェクトを作成せずに軽く文法を確認したい時や、SNSとかでRustについて語る時に便利だったりします。是非使ってみましょう！
:::

## 解説

`time_elapsed == 0` だったら前もってパニックさせて、そこで表示させたい文言を出力してしまいます。if式と `panic`マクロで実現可能です。 <font color="gray">(こっちの問題こそとりあえずifがふさわしいのでは...？)</font>

```rust:lib.rs
fn speed(start: u32, end: u32, time_elapsed: u32) -> u32 {
    // TODO: Panic with a custom message if `time_elapsed` is 0

    if time_elapsed == 0 {
        panic!("The journey took no time at all, that's impossible!");
    }

    (end - start) / time_elapsed
}
```

ちなみにこういうときは `assert_*` 系のマクロが便利です！`time_elapsed != 0` であることを確かめたいので、今回は [`assert_ne`](https://doc.rust-lang.org/std/macro.assert_ne.html) マクロが使えます。

```rust:lib.rs
fn speed(start: u32, end: u32, time_elapsed: u32) -> u32 {
    // TODO: Panic with a custom message if `time_elapsed` is 0

    assert_ne!(
        time_elapsed, 0,
        "The journey took no time at all, that's impossible!"
    );

    (end - start) / time_elapsed
}
```

`assert_*` は「条件を満たしていることを保証している」と見ると読みやすいです。 

- `assert_eq` : 第一引数と第二引数が等しいことを保証したい
    - 等しくないとパニックになる
- `assert_ne` : 第一引数と第二引数が等しくないことを保証したい
    - 等しいとパニックになる

使い慣れてないと混乱しやすいですね...そして第三引数はパニック時のカスタムメッセージを指定できるので、ここにテストで求められている文言を指定してあげればよいです。

行数的にはifを使う場合とあまり変わらない(どころか1行多い)ですが、「保証」のニュアンスが出るためこっちのほうが読みやすいという人も一定数はいるんじゃないかと思います。

:::note info
**Q: Result型を使うと良いと聞いたのだけど...？**

A: はい。こういうエラーになる状況では、いきなりパニックにするのではなくてプログラム側でエラー時の処理をカスタマイズできる [`Result` 型](https://doc.rust-lang.org/std/result/enum.Result.html) を使うほうが望ましいです。(100 Exercisesだと[中盤](https://rust-exercises.com/05_ticket_v2/06_fallibility)で紹介されているみたい...)

慣れないうちはできるだけ `Result` 型にしておけば確かに間違いないですが、パニック系統も適切な場面で使えるようになるのが理想です。以下、パニックする書き方( もとい `unwrap` 系メソッド )が有効的な例を示します。

- **コンパイル時に値が確定しており** パニックしないことが火を見るより明らかな場合
    - [`unwrap`](https://doc.rust-lang.org/std/result/enum.Result.html#method.unwrap) を使った方が読みやすくなります
- 環境変数や前提となる依存ファイルを `main` 関数序盤で読み込むような場合
    - `Result` による分岐は冗長となることがしばしばです。こういう時は [`expect`](https://doc.rust-lang.org/std/result/enum.Result.html#method.expect) を使うといい感じになります

`Result` 型はユーザー入力の処理といった「実行時まで入力が確定しない場合」に使うという意識を持っておくと適切に扱えるようになる気がします。大体のプログラムはそういうものなので(偏見)、`Result`型が適切という場合が多いのでしょう。
:::

# [[02_basic_calculator/05_factorial](https://github.com/mainmatter/100-exercises-to-learn-rust/tree/main/exercises/02_basic_calculator/05_factorial/src/lib.rs)] 関数を書いてみる

- [2.5. Factorial](https://rust-exercises.com/02_basic_calculator/05_factorial)

問題は...テスト以外コメントしかなかったのでコメントを以下にまとめます。

- 非負整数 `n` を受け取る関数 `factorial` を定義し、`n`の階乗( `n!` )を返すようにしてください
- 階乗は、`n` までのすべての正の整数の積です。例: `5! = 5 * 4 * 3 * 2 * 1 = 120`
    - `0!` は `1` と定義されています
- `factorial(0)` は `1` を返し、 `factorial(1)` も `1` を返し、 `factorial(2)` は `2` を返し...としてください
- ここまで習ったことを使ってください。**ループはまだ習ってませんね、再帰を使いましょう！**

<details><summary>問題コード全体</summary>

```rust:lib.rs
// Define a function named `factorial` that, given a non-negative integer `n`,
// returns `n!`, the factorial of `n`.
//
// The factorial of `n` is defined as the product of all positive integers up to `n`.
// For example, `5!` (read "five factorial") is `5 * 4 * 3 * 2 * 1`, which is `120`.
// `0!` is defined to be `1`.
//
// We expect `factorial(0)` to return `1`, `factorial(1)` to return `1`,
// `factorial(2)` to return `2`, and so on.
//
// Use only what you learned! No loops yet, so you'll have to use recursion!

#[cfg(test)]
mod tests {
    use crate::factorial;

    #[test]
    fn first() {
        assert_eq!(factorial(0), 1);
    }

    #[test]
    fn second() {
        assert_eq!(factorial(1), 1);
    }

    #[test]
    fn third() {
        assert_eq!(factorial(2), 2);
    }

    #[test]
    fn fifth() {
        assert_eq!(factorial(5), 120);
    }
}

```
</details>

いや確かにRustではまだループ習ってないけどだからって再帰はいいのかい...まぁいいや

## 解説

再帰を止めるためのガード節と、再帰による評価部分を書けばいいだけです。

```rust:lib.rs
fn factorial(n: u32) -> u32 {
    if n == 0 {
        return 1;
    }

    n * factorial(n - 1)
}
```

今回までの問題のまとめとしては適切でしょう。

- [文法](https://rust-exercises.com/01_intro/01_syntax)
    - 関数を定義するという形で復習になっています
- [非負整数](https://rust-exercises.com/02_basic_calculator/01_integers)
    - `u32` 型にしてしまえば負数が引数に渡される心配はなく、特に例外処理を追加する必要はありません
- [変数](https://rust-exercises.com/02_basic_calculator/02_variables)
    - 関数の引数という形で登場しています
- [if式](https://rust-exercises.com/02_basic_calculator/03_if_else) と [パニック](https://rust-exercises.com/02_basic_calculator/04_panics)
    - `0` が引数として渡された時に `n - 1` が実行されると **パニックになります** がガード節で弾いているので問題なしです
    - 筆者の書き方では式要素がないですが、[模範解答の方](https://github.com/mainmatter/100-exercises-to-learn-rust/blob/solutions/exercises/02_basic_calculator/05_factorial/src/lib.rs)は式であることの理解を求めているようです[^if]

[^if]: 筆者はこういう時ガード節の書き方のほうが好きです。注釈お気持ち表明

振り返ってみると良くできた問題でびっくりします。

---

ループ等本格的な文法はまだ出ていないのに、最後はなかなか興味深い問題でしたね。

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

次の記事: [【3】 可変・ループ・オーバーフロー](https://qiita.com/namn1125/items/4f57f8aede2f5201016f)

<details><summary>登場したPlayground</summary>

(実際に無効化したことはないですが、)Rust Playground上のデータが喪失する可能性を鑑みて、一応記事にもソースコードを掲載することとしました。

URL: https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=36e5ddbe3b3f741dfa9f74c956622bac

```rust:Rust
fn speed(start: u32, end: u32, time_elapsed: u32) -> u32 {
    let distance = end - start;
    distance / time_elapsed
}

fn main() {
    speed(1, 10, 0);
}
```
</details>