Rust 100 Ex 🏃【12/37】 Clone・Copy・Dropトレイト ～覚えるべき主要トレイトたち～

前の記事

- [【0】 準備](https://qiita.com/namn1125/items/bd1b4cd028874189a3c1) ← 初回
- ...
- [【11】 Sized トレイト・From トレイト・関連型 ～おもしろトレイトと関連型～](https://qiita.com/namn1125/items/b68990712d379a3d6a49) ← 前回
- 【12】 Clone・Copy・Dropトレイト ～ 覚えるべき主要トレイトたち ～ ← 今回

<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/) 演習第12回になります！今回紹介するトレイト達はRustでプログラミングする際に常に重要になってくる者たちです。

今回の関連ページ

- [4.11. Clone trait](https://rust-exercises.com/04_traits/11_clone)
- [4.12. Copy trait](https://rust-exercises.com/04_traits/12_copy)
- [4.13. Drop trait](https://rust-exercises.com/04_traits/13_drop)

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

- [4.11. Clone trait](https://rust-exercises.com/04_traits/11_clone)

問題はこちらです。

```rust:lib.rs
// TODO: add the necessary `Clone` implementations (and invocations)
//  to get the code to compile.

pub fn summary(ticket: Ticket) -> (Ticket, Summary) {
    (ticket, ticket.summary())
}

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

impl Ticket {
    pub fn summary(self) -> Summary {
        Summary {
            title: self.title,
            status: self.status,
        }
    }
}

pub struct Summary {
    pub title: String,
    pub status: String,
}
```

`Clone` トレイトを実装して呼んでほしい、という問題です。

## 解説

`Clone` トレイトを実装して呼ぶだけですね。

```diff_rust:lib.rs
// TODO: add the necessary `Clone` implementations (and invocations)
//  to get the code to compile.

pub fn summary(ticket: Ticket) -> (Ticket, Summary) {
-     (ticket, ticket.summary())
+     (ticket.clone(), ticket.summary())
}

+ #[derive(Clone)]
pub struct Ticket {
    pub title: String,
    pub description: String,
    pub status: String,
}

impl Ticket {
    pub fn summary(self) -> Summary {
        Summary {
            title: self.title,
            status: self.status,
        }
    }
}

pub struct Summary {
    pub title: String,
    pub status: String,
}
```

`Clone` トレイトは複製のトレイトです。所有権に厳しいRustで、変更を共有するつもりがない構造体の複製は、 `Clone` トレイトの `.clone()` メソッドを呼ぶことによって行われます。

かなり重要なトレイトではありますが、構造体に関しては幸いにして全フィールドに `Clone` トレイトが実装されていれば手動実装もとても楽なトレイトです(そうでない場合でも手動実装可能です)。書き出してみると `.clone()` メソッドが何を行うのかは一目瞭然でしょう。

```rust:Rust
struct Hoge {
    a: usize,
    b: String,
    c: Vec<bool>,
}

impl Clone for Hoge {
    // 元の変数の所有権は奪わず、新しい構造体インスタンスを返している
    fn clone(&self) -> Self {
        Self {
            // 複製されてそう
            a: self.a.clone(),
            b: self.b.clone(),
            c: self.c.clone(),
        }
    }
}
```

そしてこの処理を自動実装してくれるのが `Clone` deriveマクロです。 **`Clone` マクロを使うには、全フィールドの型が `Clone` トレイトを実装している必要があります。** 下手に手動実装するより、この制約を守りながらderiveマクロで実装するのが定石でしょう。

このマクロを使用して `Clone` を実装すると嬉しいこととして、 `.clone()` メソッドを呼び出すと複製が再帰的に呼び出されます。すなわちデフォルトで **ディープコピーされる** わけです！

所有権や参照という仕組み、そしてここまでの演習からもしかしたら察しがつくかもしれませんが、 **Rustにはシャローコピーという考え方は基本的にありません** [^shallow]。 もちろん工夫をすればシャローコピーに準じた実装をすることが可能ですが、その場合ちょっと大掛かりになる([第29回](https://qiita.com/namn1125/items/861e72dbb4b837508948)か、下記に示す拙著を参照してほしいです)ので普段は気にする必要がありません。他言語で散々プログラマを惑わすあの罠は、Rustには基本通用しないのです！

[^shallow]: 「参照が複製される様はシャローコピーでは？」というツッコミが来そうですが、「なんでわざわざそんな難しい言い方をするのですか？『参照が複製される』と表現すれば良くないですか？」と返したくなっちゃうんですよね。もとい、シャローコピーという考え方がない、というよりは、そういう言い回しをしない、という方が正確なのかもしれません。

:::note 
もっと詳しい話は拙著を読んでくださると恐悦至極です！:bow:

[Rustにはシャローコピーがわからない - Qiita](https://qiita.com/namn1125/items/2d84086394e97489776a)
:::

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

- [4.12. Copy trait](https://rust-exercises.com/04_traits/12_copy)

問題はこちらです。

```rust:lib.rs
// TODO: implement the necessary traits to make the test compile and pass.
//  You *can't* modify the test.

pub struct WrappingU32 {
    value: u32,
}

impl WrappingU32 {
    pub fn new(value: u32) -> Self {
        Self { value }
    }
}

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

    #[test]
    fn test_ops() {
        let x = WrappingU32::new(42);
        let y = WrappingU32::new(31);
        let z = WrappingU32::new(u32::MAX);
        assert_eq!(x + y + y + z, WrappingU32::new(103));
    }
}
```

「テストを変えずにコンパイルを通してね」問題になります。

## 解説

`.clone()` メソッドが呼び出されていないので `Clone` トレイトだけでは不十分です。 **マーカートレイト `Copy` も実装することで、所有権を奪われそうになったら自動複製されるようにします。**

```diff_rust:lib.rs
use std::ops::Add;

+ #[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub struct WrappingU32 {
    value: u32,
}

impl WrappingU32 {
    pub fn new(value: u32) -> Self {
        Self { value }
    }
}

impl Add for WrappingU32 {
    type Output = Self;

    fn add(self, rhs: Self) -> Self::Output {
        Self {
            value: self.value.wrapping_add(rhs.value),
        }
    }
}
```

`Copy` トレイトを実装するには、前提として `Clone` トレイトが実装されている必要があるため、回答には `Clone` トレイトも付けています。

`Copy` トレイトの付与にはもう一つ条件があって、**内包するフィールド全てが `Copy` トレイトを実装している** 必要があります。そして、 `Copy` を実装している型は大体 **スタック上に値が保持されるプリミティブ型** です。ヒープアロケーションが必要な型( `String` や `Vec<T>` など)を内包している時は `Copy` は実装できないと考えておきましょう。

:::note warn
`Clone` トレイトを付与していることから内部的に `.clone()` を呼んでいると勘違いしがちですが(実際筆者は勘違いしていました。)、 `Copy` トレイトが付与された型の複製は、スタックメモリ上の値がそのまま別な場所に複製されるだけで **`.clone()` は呼ばれません！**

`Copy` を実装している型で `.clone()` にて変わった処理を実装することは可能ですが、その場合望まない結果になることが容易に予想されるので、やめておいた方が良さそうです。

参考: https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=de1113871471d8e7deb6aeae09c48dc7

`Copy` による自動複製では `.clone()` が呼ばれていないことが観測できます。
:::

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

- [4.13. Drop trait](https://rust-exercises.com/04_traits/13_drop)

問題はこちらです。

```rust:lib.rs
// TODO: implement a so-called "Drop bomb": a type that panics when dropped
//  unless a certain operation has been performed on it.
//  You can see the expected API in the tests below.

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

    #[test]
    #[should_panic]
    fn test_drop_bomb() {
        let bomb = DropBomb::new();
        // The bomb should panic when dropped
    }

    #[test]
    fn test_defused_drop_bomb() {
        let mut bomb = DropBomb::new();
        bomb.defuse();
        // The bomb should not panic when dropped
        // since it has been defused
    }
}
```

「ドロップ前にリソースをしっかりと解放していないとパニックになる、『Drop爆弾』を実装してください」という問題です。

## 解説

Rustのリソース管理便利トレイト、 `Drop` の登場です！このトレイトにより提供される `drop` メソッドは、 **変数のドロップ時に呼び出されます** ！

```rust:lib.rs
struct DropBomb {
    defused: bool,
}

impl DropBomb {
    fn new() -> Self {
        Self { defused: false }
    }

    fn defuse(&mut self) {
        self.defused = true;
    }
}

impl Drop for DropBomb {
    fn drop(&mut self) {
        if !self.defused {
            panic!("Resources are not yet cleaned up! Please call `defuse` method before drop to clean up it.");
        }
    }
}
```

この性質を利用してテストを通します！DropBombの値のライフタイムが終了してドロップされる際に `drop` メソッドの中身が呼ばれるので、 `defuse` メソッドであらかじめ然るべきリソース解放処理をしていないと、パニックしてしまう、という寸法です。

`Drop` トレイトを実装すれば、Rustのライフタイムの仕組みを借りて、リソース管理ができるのです！Pythonの with 文やC#のuseブロックに近い感じでしょうか...？

これは例えば[以前](https://qiita.com/namn1125/items/7247edde3b6bd0b85b25)少し触れたようにファイルハンドラや、そしてDBのコネクションやトランザクション等にも応用できます。

実際の実装例: https://github.com/sfackler/rust-postgres/blob/a1bdd0bf15325cdc05fcfe3c0671953b2a8c7981/postgres/src/transaction.rs#L16

トランザクション等の `close` の呼び忘れを気にしなくて良いので、とても強力なトレイトですね。常に意識しておきたいです。

:::note warn
Bookに書かれていることですが、 **`Copy` トレイトと `Drop` トレイトは共存できません！** 。これも筆者知らなかったよ...

`Copy` トレイトが実装される型はスタック上でしか扱われない軽い型であるというコンセプトを鑑みると、リソース片付けを目的とする `Drop` トレイトが共存不可というのは納得できる話ではあります。
:::

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

次の記事: [【13】 トレイトまとめ・列挙型・match式 ～最強のトレイトの次は、最強の列挙型～](https://qiita.com/namn1125/items/6b2cc31d6a47f9ffaff6)

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

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

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

```rust:Rust
#[derive(Debug)]
struct Hoge(u32);

impl Clone for Hoge {
    fn clone(&self) -> Self {
        println!("beep!: {}", self.0);    

        Hoge(self.0)
    }
}

impl Copy for Hoge {}

fn main() {
    let h = Hoge(10);
    let h2 = h;
    
    dbg!(h);
    dbg!(h2);
    dbg!(h);
    h.clone();
}
```
</details>