Discourage use of static mut in singleton

Open
#389 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
documentation, embedded-iot

Research direction

Start with the Singleton documentation page linked in the issue and inspect the static mut PERIPHERALS example. Update the example and surrounding explanation so it is valid for Rust 2024 and no longer produces the reported mutable-reference error; verify the revised documentation example with the relevant Rust toolchain.

Written by the indexing model from the issue text.

Description

The code in this part about Singleton no longer works as of Rust 2024

https://docs.rust-embedded.org/book/peripherals/singletons.html

static mut PERIPHERALS: Peripherals = Peripherals {
    serial: Some(SerialPort),
};

giving error instead of warning "mutable reference to mutable static"

Dominant language
No language data
Stars
1.3k
Forks
223
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-embedded/book

All issues in rust-embedded/book

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.