RefCell overview in Rust

Introduction

RefCell lets you change data even when Rust normally would not allow it. It helps manage data safely inside a single thread.

When you want to change data inside something that is usually read-only.

When you need to borrow data mutably but only at runtime.

When you want to check borrowing rules while the program runs, not at compile time.

When you have shared data but only one part changes it at a time.

When you want to avoid complex ownership rules but still keep safety.

Syntax

Rust

use std::cell::RefCell;

let data = RefCell::new(5);

// Borrow immutably
let value = data.borrow();

// Borrow mutably
let mut value_mut = data.borrow_mut();

RefCell::new(value) creates a new RefCell holding the value.

borrow() gives an immutable reference, borrow_mut() gives a mutable reference.

Examples

This example shows how to read the value inside a RefCell.

Rust

use std::cell::RefCell;

let data = RefCell::new(10);
let val = data.borrow();
println!("Value: {}", *val);

This example shows how to change the value inside a RefCell.

Rust

use std::cell::RefCell;

let data = RefCell::new(10);
{
    let mut val_mut = data.borrow_mut();
    *val_mut += 5;
}
println!("Updated value: {}", *data.borrow());

You can also use RefCell with complex data like vectors to modify them.

Rust

use std::cell::RefCell;

let data = RefCell::new(vec![1, 2, 3]);
data.borrow_mut().push(4);
println!("Vector: {:?}", *data.borrow());

Sample Program

This program shows how RefCell allows changing a value safely inside one thread. It borrows the value immutably, then mutably changes it, then reads it again.

Rust

use std::cell::RefCell;

fn main() {
    let shared_number = RefCell::new(100);

    // Borrow immutably
    let num1 = shared_number.borrow();
    println!("First borrow: {}", *num1);

    // Borrow mutably
    {
        let mut num2 = shared_number.borrow_mut();
        *num2 += 50;
        println!("After mutation: {}", *num2);
    }

    // Borrow immutably again
    let num3 = shared_number.borrow();
    println!("Final value: {}", *num3);
}

Important Notes

RefCell checks borrowing rules at runtime, so borrowing errors cause the program to panic.

Use RefCell only when you are sure you need interior mutability inside one thread.

For multi-threaded cases, use types like Mutex or RwLock.

Summary

RefCell allows changing data even when Rust normally forbids it.

It enforces borrowing rules at runtime, not compile time.

Use it for safe interior mutability inside a single thread.

Practice

1. What is the main purpose of RefCell in Rust?

easy

A. To enable safe sharing of data across multiple threads

B. To enforce borrowing rules at compile time

C. To replace all uses of Box for heap allocation

D. To allow mutation of data even when the data is borrowed immutably

Solution

1. Step 1: Understand RefCell's role

   RefCell allows mutation of data even when it is borrowed immutably by enforcing borrowing rules at runtime.

2. Step 2: Compare with other options

   RefCell is not for multi-threading (that's for Mutex or RwLock), nor does it replace Box or enforce compile-time checks.

3. Final Answer:

   To allow mutation of data even when the data is borrowed immutably -> Option D

4. Quick Check:

   RefCell enables interior mutability = B [OK]

Hint: RefCell allows changing data inside immutable references [OK]

Common Mistakes:

• Confusing RefCell with thread-safe types
• Thinking RefCell enforces compile-time checks
• Assuming RefCell replaces Box for heap allocation

2. Which of the following is the correct way to create a RefCell containing an integer value 10?

easy

A. let x = RefCell::create(10);

B. let x = RefCell(10);

C. let x = RefCell::new(10);

D. let x = new RefCell(10);

Solution

1. Step 1: Recall RefCell creation syntax

   RefCell is created using the associated function new like RefCell::new(value).

2. Step 2: Check options

   Only let x = RefCell::new(10); uses the correct syntax. Options A, B, and D are invalid Rust syntax for RefCell creation.

3. Final Answer:

   let x = RefCell::new(10); -> Option C

4. Quick Check:

   Use RefCell::new(value) to create [OK]

Hint: Use RefCell::new(value) to create a RefCell [OK]

Common Mistakes:

• Using RefCell(10) without ::new
• Trying to call RefCell::create which doesn't exist
• Using new RefCell(10) like other languages

3. What will be the output of this Rust code?

use std::cell::RefCell;

fn main() {
    let data = RefCell::new(5);
    *data.borrow_mut() += 10;
    println!("{}", data.borrow());
}

medium

A. 15

B. 5

C. Compilation error

D. Runtime panic

Solution

1. Step 1: Understand the code behavior

   The RefCell holds 5 initially. The mutable borrow adds 10, changing the value to 15.

2. Step 2: Print the current value

   The immutable borrow prints the updated value, which is 15.

3. Final Answer:

   15 -> Option A

4. Quick Check:

   RefCell allows mutation inside borrow_mut = 15 [OK]

Hint: borrow_mut lets you change the value inside RefCell [OK]

Common Mistakes:

• Expecting original value 5 to print
• Thinking borrow_mut causes compile error
• Confusing borrow() and borrow_mut() usage

4. What error occurs when you try to borrow a RefCell mutably twice at the same time?

use std::cell::RefCell;

fn main() {
    let cell = RefCell::new(10);
    let mut1 = cell.borrow_mut();
    let mut2 = cell.borrow_mut();
}

medium

A. Runtime panic due to multiple mutable borrows

B. Syntax error: borrow_mut() not found

C. No error, code runs fine

D. Compile-time borrow checker error

Solution

1. Step 1: Understand RefCell borrowing rules

   RefCell enforces borrowing rules at runtime, so multiple mutable borrows cause a panic at runtime.

2. Step 2: Analyze the code

   Two mutable borrows happen simultaneously, which is forbidden and triggers a runtime panic.

3. Final Answer:

   Runtime panic due to multiple mutable borrows -> Option A

4. Quick Check:

   RefCell panics on multiple mutable borrows [OK]

Hint: Only one mutable borrow allowed at runtime in RefCell [OK]

Common Mistakes:

• Expecting compile-time error instead of runtime panic
• Thinking multiple mutable borrows are allowed
• Confusing syntax errors with borrowing errors

5. You want to safely mutate a value inside a struct shared only within one thread. Which is the best way to do this using RefCell?

struct Counter {
    count: RefCell<i32>,
}

impl Counter {
    fn new() -> Self {
        Counter { count: RefCell::new(0) }
    }

    fn increment(&self) {
        // Fill in this method
    }
}

What code should replace the comment to increment the count safely?

hard

A. self.count = RefCell::new(*self.count.borrow() + 1);

B. *self.count.borrow_mut() += 1;

C. self.count.borrow() += 1;

D. self.count += 1;

Solution

1. Step 1: Understand how to mutate RefCell inside a method

   To change the value inside RefCell, we borrow it mutably with borrow_mut() and then modify the dereferenced value.

2. Step 2: Check each option

   *self.count.borrow_mut() += 1; correctly mutably borrows and increments. self.count = RefCell::new(*self.count.borrow() + 1); tries to replace the RefCell which is not allowed. self.count.borrow() += 1; tries to mutate an immutable borrow. self.count += 1; tries to add directly to RefCell which is invalid.

3. Final Answer:

   *self.count.borrow_mut() += 1; -> Option B

4. Quick Check:

   Use borrow_mut() to mutate RefCell value [OK]

Hint: Use *borrow_mut() to change RefCell's inner value [OK]

Common Mistakes:

• Trying to assign a new RefCell instead of mutating inside
• Using borrow() instead of borrow_mut() for mutation
• Trying to add directly to RefCell without borrowing