Commit263861f

committed

Update safety docs for AtomicBool::from_ptr.

Clarify that alignment is never an issue, since `align_of::<AtomicBool>() == 1`.

1 parentcf9de23 commit263861fCopy full SHA for 263861f

File tree

-2

lines changed

-2

lines changed

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -443,8 +443,8 @@ impl AtomicBool {`
`443`	`443`	`///`
`444`	`444`	`/// # Safety`
`445`	`445`	`///`
`446`		-/// * `ptr` must be aligned to `align_of::<AtomicBool>()` (note thaton some platforms this can
`447`		-///be bigger than`align_of::<bool>()`).
	`446`	+/// * `ptr` must be aligned to `align_of::<AtomicBool>()` (note thatthis is always true, since
	`447`	+/// `align_of::<AtomicBool>() == 1`).
`448`	`448`	/// * `ptr` must be [valid] for both reads and writes for the whole lifetime `'a`.
`449`	`449`	`/// * You must adhere to the [Memory model for atomic accesses]. In particular, it is not`
`450`	`450`	`/// allowed to mix atomic and non-atomic accesses, or atomic accesses of different sizes,`

Comments

(0)