Skip to content

Commit 8b24b78

Browse files
committed
update Atomic*::from_ptr and Atomic*::as_ptr docs
1 parent 8c12d76 commit 8b24b78

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

library/core/src/sync/atomic.rs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -563,8 +563,8 @@ impl AtomicBool {
563563
/// `align_of::<AtomicBool>() == 1`).
564564
/// * `ptr` must be [valid] for both reads and writes for the whole lifetime `'a`.
565565
/// * You must adhere to the [Memory model for atomic accesses]. In particular, it is not
566-
/// allowed to mix atomic and non-atomic accesses, or atomic accesses of different sizes,
567-
/// without synchronization.
566+
/// allowed to mix conflicting atomic and non-atomic accesses, or atomic accesses of different
567+
/// sizes, without synchronization.
568568
///
569569
/// [valid]: crate::ptr#safety
570570
/// [Memory model for atomic accesses]: self#memory-model-for-atomic-accesses
@@ -1246,7 +1246,7 @@ impl AtomicBool {
12461246
/// atomic types work with interior mutability. All modifications of an atomic change the value
12471247
/// through a shared reference, and can do so safely as long as they use atomic operations. Any
12481248
/// use of the returned raw pointer requires an `unsafe` block and still has to uphold the same
1249-
/// restriction: operations on it must be atomic.
1249+
/// restriction: no data races and no mixed-size accesses.
12501250
///
12511251
/// # Examples
12521252
///
@@ -1519,8 +1519,8 @@ impl<T> AtomicPtr<T> {
15191519
/// can be bigger than `align_of::<*mut T>()`).
15201520
/// * `ptr` must be [valid] for both reads and writes for the whole lifetime `'a`.
15211521
/// * You must adhere to the [Memory model for atomic accesses]. In particular, it is not
1522-
/// allowed to mix atomic and non-atomic accesses, or atomic accesses of different sizes,
1523-
/// without synchronization.
1522+
/// allowed to mix conflicting atomic and non-atomic accesses, or atomic accesses of different
1523+
/// sizes, without synchronization.
15241524
///
15251525
/// [valid]: crate::ptr#safety
15261526
/// [Memory model for atomic accesses]: self#memory-model-for-atomic-accesses
@@ -2488,7 +2488,7 @@ impl<T> AtomicPtr<T> {
24882488
/// atomic types work with interior mutability. All modifications of an atomic change the value
24892489
/// through a shared reference, and can do so safely as long as they use atomic operations. Any
24902490
/// use of the returned raw pointer requires an `unsafe` block and still has to uphold the same
2491-
/// restriction: operations on it must be atomic.
2491+
/// restriction: no data races and no mixed-size accesses.
24922492
///
24932493
/// # Examples
24942494
///
@@ -2696,8 +2696,8 @@ macro_rules! atomic_int {
26962696
}]
26972697
/// * `ptr` must be [valid] for both reads and writes for the whole lifetime `'a`.
26982698
/// * You must adhere to the [Memory model for atomic accesses]. In particular, it is not
2699-
/// allowed to mix atomic and non-atomic accesses, or atomic accesses of different sizes,
2700-
/// without synchronization.
2699+
/// allowed to mix conflicting atomic and non-atomic accesses, or atomic accesses of different
2700+
/// sizes, without synchronization.
27012701
///
27022702
/// [valid]: crate::ptr#safety
27032703
/// [Memory model for atomic accesses]: self#memory-model-for-atomic-accesses
@@ -3618,7 +3618,7 @@ macro_rules! atomic_int {
36183618
/// atomic types work with interior mutability. All modifications of an atomic change the value
36193619
/// through a shared reference, and can do so safely as long as they use atomic operations. Any
36203620
/// use of the returned raw pointer requires an `unsafe` block and still has to uphold the same
3621-
/// restriction: operations on it must be atomic.
3621+
/// restriction: no data races and no mixed-size accesses.
36223622
///
36233623
/// # Examples
36243624
///

0 commit comments

Comments
 (0)