diff options
| author | est31 <MTest31@outlook.com> | 2023-05-01 16:39:54 +0200 |
|---|---|---|
| committer | est31 <MTest31@outlook.com> | 2023-05-01 16:41:06 +0200 |
| commit | 09c50a0ae309dab351cb6c4d0f570a57ea72a7e9 (patch) | |
| tree | f8c075e3c45ae39b96665aeb5735d0e6f396273c | |
| parent | f2eb9f85b9b52e6538c3c7fc160725963272d471 (diff) | |
| download | rust-09c50a0ae309dab351cb6c4d0f570a57ea72a7e9.tar.gz rust-09c50a0ae309dab351cb6c4d0f570a57ea72a7e9.zip | |
Explicitly document how Send and Sync relate to references
Some of these relations were already mentioned in the text, but that Send is implemented for &mut impl Send was not mentioned, neither did the docs list when &T is Sync.
| -rw-r--r-- | library/core/src/marker.rs | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/library/core/src/marker.rs b/library/core/src/marker.rs index 40789cb3049..82e4c648974 100644 --- a/library/core/src/marker.rs +++ b/library/core/src/marker.rs @@ -24,7 +24,7 @@ use crate::hash::Hasher; /// operations. Its cousin [`sync::Arc`][arc] does use atomic operations (incurring /// some overhead) and thus is `Send`. /// -/// See [the Nomicon](../../nomicon/send-and-sync.html) for more details. +/// See [the Nomicon](../../nomicon/send-and-sync.html) and the [`Sync`] trait for more details. /// /// [`Rc`]: ../../std/rc/struct.Rc.html /// [arc]: ../../std/sync/struct.Arc.html @@ -426,6 +426,11 @@ pub macro Copy($item:item) { /// becomes read-only, as if it were a `& &T`. Hence there is no risk /// of a data race. /// +/// A shorter overview of how [`Sync`] and [`Send`] relate to referencing: +/// * `&T` is [`Send`] if and only if `T` is [`Sync`] +/// * `&mut T` is [`Send`] if and only if `T` is [`Send`] +/// * `&T` and `&mut T` are [`Sync`] if and only if `T` is [`Sync`] +/// /// Types that are not `Sync` are those that have "interior /// mutability" in a non-thread-safe form, such as [`Cell`][cell] /// and [`RefCell`][refcell]. These types allow for mutation of |
