rust-lang / rust-lang/nomicon

Can we have some more info on Send and Sync

Open
#92 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

C-enhancement
Dominant language
CSS
Stars
2.3k
Forks
325
PR merge metrics
No merged PRs in 30d

Description

The current documentation has a TODO: better explain what can or can't be Send or Sync. Sufficient to appeal only to data races?

The explanation on what can and can't be Send or Sync would be very useful. For instance, it could contain why LinkedList is Send while it contains pointer fields that are not Send and this is Ok and the changes that could be introduced to this container so it actually stops being Send.

Thanks

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.

Research direction

Start with the current documentation section containing the TODO about what can or cannot be Send or Sync. Explain the relevant rules, including why LinkedList is Send despite pointer fields, and describe changes that could make the container no longer Send. Done means the documentation answers these questions clearly.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.