Rust のクロージャにおける mut の効果範囲

下記コードの (A)、(B) の部分について、mut の効果範囲に疑問を感じています。
私の Rust に関する知識が浅く、疑問自体をうまく表現できていない状態で大変申し訳ありません。
以下のような考え方で合っているのかどうか、自分ではわからない状態で悩んでいます。
すみませんが、ご教授をいただけると本当にありがたいです。

(A) においては、rect の内容が変更されないから mut は不要。
right_bottom の参照先は書き換わるけれど、right_bottom を指すアドレス自体は変更されないため。

(B) においては、func でキャプチャされる変数が、rect だけでなく rb にも及ぶ。（lt はキャプチャされない）
そのためクロージャ生成時に、rect と rb を含む構造体が生成されて、move_x() 実行時に rb が変更されると判断されて、func に mut が必要となる。

#[derive(Debug)]
struct Point {
    x: i32,
    y: i32,
}

impl Point {
    fn move_x(&mut self) {
        self.x += 10;
    }	
}

#[derive(Debug)]
struct Rectangle<'a> {
    left_top: Point,
    right_bottom: &'a mut Point,
}

fn main() {
    let lt = Point { x: 1, y: 1 };
    let mut rb = Point { x: 5, y: 5 };

    let rect = Rectangle { left_top: lt, right_bottom: &mut rb };
    // (A) rect に mut が付与されていなくても move_x（）は実行可能
    rect.right_bottom.move_x();
    println!("rect: {:?}", rect);

    // (B) func に mut を付与しないと、move_x（）は実行不可能
    let mut func = || {
        rect.right_bottom.move_x();
    };

    func();
    println!("rect: {:?}", rect);
}

行動規範の内容に同意します

回答1件

ベストアンサー

(A) においては、rect の内容が変更されないから mut は不要。
right_bottom の参照先は書き換わるけれど、right_bottom を指すアドレス自体は変更されないため。

その考え方で合っています。

(B) においては、func でキャプチャされる変数が、rect だけでなく rb にも及ぶ。（lt はキャプチャされない）
そのためクロージャ生成時に、rect と rb を含む構造体が生成されて、move_x() 実行時に rb が変更されると判断されて、func に mut が必要となる。

なんとなく合っているような気がしますが、できるだけ正確に説明してみます。

funcにmutが必要になる直接的な理由は、func();のところでFnMutのcall_mut(&mut self, ..)メソッドが使われるからです。&mut selfを得るためにはself（=func）がmutでなければなりません。これは&mut rbを得るためにlet mut rbにするのと同じ理由です。

ちなみに他のFnOnceとFnのcall..(..)メソッドでは、順にself、&selfを引数に取るためfuncのmutを付ける必要はありません。

クロージャが定義されたときにFnMutなどのどのトレイトが実装されるかは、以下の優先順位で決定されるようです。

Fn、FnMut、FnOnceの全てを実装する
FnMutとFnOnceを実装する
FnOnceだけを実装する

クロージャをコールするときにどのトレイトメソッドが使われるかは、コード側で指定（制約）がなければ以下の優先順位で決定されるようです。

Fnを実装しているならcall(&self, ..)
FnMutを実装しているならcall_mut(&mut self, ..)
FnOnceのcall_once(self, ..)

コード側の指定というのは、たとえば別の質問の回答で書いたように、impl FnOnce()を引数に取る関数にクロージャを渡したときのようなことを指します。

ご質問のコードでは使用するトレイトメソッドの指定はされておらず、またfuncにmutが必要なことからcall_mut(&mut self, ..)が使われていることがわかります。ですから、そのクロージャはFnMutとFnOnceを実装していると考えられます。（Fnは実装されていない）

Fnが実装されていない理由ですが、move_x()が&mut self（ここでのselfはPoint）を要求するからです。Fnが要求するメソッドはcall(&self, ..)ですが、&をとおして&mutを得ることができず、従ってFnを実装できません。&をとおして&mutを得られないことはご質問のコードに以下のコードを追加することで確認できます。

rust
1    // Rectangleの不変借用
2    let rect1 = &rect;
3    rect1.right_bottom.move_x();  // コンパイルエラーになる

エラーの内容は以下のとおりです。

console
1error[E0596]: cannot borrow `*rect1.right_bottom` as mutable, as it is behind a `&` reference
2  --> src/bin/main1.rs:30:5
3   |
429 |     let rect1 = &rect;
5   |                 ----- help: consider changing this to be a mutable reference: `&mut rect`
630 |     rect1.right_bottom.move_x();
7   |     ^^^^^^^^^^^^^^^^^^ `rect1` is a `&` reference, so the data it refers to cannot be borrowed as mutable

最後にキャプチャされる変数ですが、

func でキャプチャされる変数が、rect だけでなく rb にも及ぶ。（lt はキャプチャされない）

今回のケースでは以下の2種類のどちらかでキャプチャされると考えられます。

&mut rectをキャプチャする。（クロージャ内ではleft_topフィールドとright_bottomフィールドにアクセスできる）
&mut rect.right_bottomをキャプチャする。（クロージャ内ではright_bottomフィールドだけにアクセスできる）

実際のコードではright_bottomフィールドだけにアクセスするので後者が好ましく思えますが、こちらのissue を読んだ感じでは、現在のRustバージョンでは前者になっているようです。そのissueは前者から後者に変更するためのものですが、設計面で考慮することがいろいろとあり、まだ実現されてないようです。

今までの話をまとめますと、以下のようになります。

funcにmutが必要になる直接的な理由は、クロージャをコールするときにFnMutのcall_mut(&mut self, ..)メソッドが使われるから
call_mut(&mut self, ..)が使われる理由は、クロージャがFnMutとFnOnceを実装しており、Fnは実装していないから
クロージャがFnを実装できない理由はmove_x()メソッドが&mutを要求するから

最後に、余談ですが、2のところはコードで指定することでcall_mut(&mut self, ..)ではなく、call_once(self, ..)を使うことも可能です。

rust
1    // funcを「FnOnceを実装したトレイトオブジェクト」へと型強制することで
2    // `call_once()`を使うように仕向けられる。これによりfuncのmutは不要になるが
3    // 1回しか呼べなくなる
4    let func: Box<dyn FnOnce()> = Box::new(|| {
5        rect.right_bottom.move_x();
6    });
7    func();
8    func();  // FnOnceなので2回目のコールはできない。コンパイルエラーになる

投稿2021/05/03 00:52

編集2021/05/03 01:00

tatsuya6502

総合スコア2046

KN2018

2021/05/03 06:03

前回させていただいた質問に引き続き、とても丁寧にご教授くださり、深く感謝しております。前回に教えてくださったことを頭に入れて考えていたのですが、クロージャ生成による匿名構造体へのアクセスについて考えるのではなく、「& を通した参照では、&mut を取得できない」と考えるべき、ということがはっきり分かり、とても納得できました。最後の余談の部分のコードも、初学者の私には大変参考になりました。トレイトオブジェクトが簡単にダウンキャストできたらいいのだろうけど、Rustはそういうのは難しいと聞いていますので、このように書く必要があるのかと、とても参考にさせていただいています。クロージャというありきたりな単語でインターネット上を検索しても、知りたい情報にたどり着けず何時間もさまよってしまっていたので、的確に教えてくださり非常に深く感謝しております。貴重なお時間をたくさん割いてくださり、本当に本当にありがとうございました。

行動規範の内容に同意します