RefCell<T> — 実行時に借用を検査するのサンプルコード — Rust

1最小の RefCell — let mut なしで書き換える

mut を付けていない変数の中身を、borrow_mut() 経由で書き換える最小の例です。外から見れば counter は不変ですが、RefCell が内側での変更を許してくれます。これが「内部可変性」で、読むときは borrow()、書くときは borrow_mut() と使い分けます。

Rust

use std::cell::RefCell;

fn main() {
    let counter = RefCell::new(0); // let mut なしで宣言
    *counter.borrow_mut() += 1; // 書き換えの借用を取り出して加算
    *counter.borrow_mut() += 1;
    println!("counter = {}", *counter.borrow()); // 読み取りの借用
}

2借用ルールは実行時に検査される

「読み取りの借用は同時に複数OK、書き換えの借用は同時に1つだけ」というおなじみのルールが、RefCell では実行時に検査されることを確かめる例です。borrow_mut の結果をブロックで囲んで早めに手放せば、その後は自由に借り直せます。ルール違反はコンパイルエラーではなく panic になる、という違いが最大の注意点です。

Rust

use std::cell::RefCell;

fn main() {
    let data = RefCell::new(vec![1, 2, 3]);

    {
        let mut items = data.borrow_mut(); // 書き換えの借用は同時に1つだけ
        items.push(4);
    } // ここで書き換えの借用が終わる

    let read1 = data.borrow(); // 読み取りの借用は
    let read2 = data.borrow(); // 同時に複数あってよい
    println!("read1 = {:?}", read1);
    println!("read2 = {:?}", read2);
    // この状態で data.borrow_mut() を呼ぶと実行時に panic する
}

3&self のメソッドで内部カウンタを更新

読み取り専用に見える &self のメソッドの中で、RefCell に包んだカウンタを更新する例です。「外向きの API は不変のまま、内部の統計情報だけ育てたい」という場面の定番構成で、アクセス回数の記録やメトリクス収集がこの形になります。呼び出し側は page を mut にする必要がありません。

Rust

use std::cell::RefCell;

struct PageView {
    count: RefCell<u32>,
}

impl PageView {
    fn visit(&self) { // &mut self ではなく &self のまま書き換えられる
        *self.count.borrow_mut() += 1;
    }
}

fn main() {
    let page = PageView { count: RefCell::new(0) };
    page.visit();
    page.visit();
    page.visit();
    println!("訪問回数 = {}", *page.count.borrow());
}

4Rc + RefCell — 共有データをどこからでも書き換える

読み取り共有しかできない Rc と、書き換えを許す RefCell を組み合わせた定番コンビの例です。タスクリストを複数のチームで共有し、どの所有者からも borrow_mut で追加できます。シングルスレッドで「共有かつ可変」が必要になったら、まずこの Rc<RefCell<T>> を思い出してください。

Rust

use std::cell::RefCell;
use std::rc::Rc;

fn main() {
    let tasks = Rc::new(RefCell::new(vec![String::from("設計")]));
    let team_a = Rc::clone(&tasks); // 共有しつつ
    let team_b = Rc::clone(&tasks); // どの所有者からも書き換えられる

    team_a.borrow_mut().push(String::from("実装"));
    team_b.borrow_mut().push(String::from("テスト"));

    println!("タスク数 = {}", tasks.borrow().len());
    for task in tasks.borrow().iter() {
        println!("- {}", task);
    }
}

5計算結果のキャッシュ — &self のまま育てる HashMap

計算結果を RefCell<HashMap> にためておき、2回目以降はキャッシュから返す実務寄りの例です。呼び出し側から見れば square は読み取り専用のメソッドなのに、内部ではキャッシュが育っていきます。出力で「計算した」が1回しか出ないことが、キャッシュが効いた証拠です。

Rust

use std::cell::RefCell;
use std::collections::HashMap;
struct Calculator {
    cache: RefCell<HashMap<u64, u64>>, // &self のまま書き換えたい
}
impl Calculator {
    fn square(&self, n: u64) -> u64 {
        if let Some(v) = self.cache.borrow().get(&n) {
            return *v; // 2回目以降はキャッシュから返す
        }
        println!("({} の2乗を計算した)", n);
        self.cache.borrow_mut().insert(n, n * n);
        n * n
    }
}
fn main() {
    let calc = Calculator { cache: RefCell::new(HashMap::new()) };
    println!("1回目: {}", calc.square(9));
    println!("2回目: {}", calc.square(9)); // 「計算した」は出ない
}

サンプルコードで身につける: RefCell<T> — 実行時に借用を検査する

1最小の RefCell — let mut なしで書き換える

2借用ルールは実行時に検査される

3&self のメソッドで内部カウンタを更新

4Rc + RefCell — 共有データをどこからでも書き換える

5計算結果のキャッシュ — &self のまま育てる HashMap