Skip to content

Commit

Permalink
Update readme to match docs
Browse files Browse the repository at this point in the history
  • Loading branch information
EricLBuehler committed Jul 12, 2023
1 parent 614a6ce commit 8a51875
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ A `Weak<T>` is a non-owning reference to the data held by a `Trc<T>`.
They break reference cycles by adding a layer of indirection and act as an observer. They cannot even access the data directly, and
must be converted back into `Trc<T>`. `Weak<T>` does not keep the value alive (which can be dropped), and only keeps the backing allocation alive.

To soundly implement thread safety `Trc<T>` does not implement `Send` or `Sync`. However, `SharedTrc<T>` does, and it is the only way to safely send a `Trc<T>` across threads. See `SharedTrc` for it's API, which is similar to that of `Weak`.
To soundly implement thread safety `Trc<T>` does not itself implement [`Send`] or [`Sync`]. However, `SharedTrc<T>` does, and it is the only way to
safely send a `Trc<T>` across threads. See [`SharedTrc`] for it's API, which is similar to that of `Weak`.


## Examples
Expand Down

0 comments on commit 8a51875

Please sign in to comment.