bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Use &raw for ptr primitive docs

Browse source
This commit is contained in:
Yusuf Bham 2024-12-21 15:35:33 -05:00
parent 387b245664
commit 466335205f
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
library/core/src/primitive_docs.rs
View file

@ -563,11 +563,11 @@ impl () {}
/// Note that here the call to [`drop`] is for clarity - it indicates /// Note that here the call to [`drop`] is for clarity - it indicates
/// that we are done with the given value and it should be destroyed. /// that we are done with the given value and it should be destroyed.
/// ///
/// ## 3. Create it using `ptr::addr_of!` /// ## 3. Create it using `&raw`
/// ///
/// Instead of coercing a reference to a raw pointer, you can use the macros /// Instead of coercing a reference to a raw pointer, you can use the raw borrow
/// [`ptr::addr_of!`] (for `*const T`) and [`ptr::addr_of_mut!`] (for `*mut T`). /// operators `&raw const` (for `*const T`) and `&raw mut` (for `*mut T`).
/// These macros allow you to create raw pointers to fields to which you cannot /// These operators allow you to create raw pointers to fields to which you cannot
/// create a reference (without causing undefined behavior), such as an /// create a reference (without causing undefined behavior), such as an
/// unaligned field. This might be necessary if packed structs or uninitialized /// unaligned field. This might be necessary if packed structs or uninitialized
/// memory is involved. /// memory is involved.
@ -580,7 +580,7 @@ impl () {}
/// unaligned: u32, /// unaligned: u32,
/// } /// }
/// let s = S::default(); /// let s = S::default();
/// let p = std::ptr::addr_of!(s.unaligned); // not allowed with coercion /// let p = &raw const s.unaligned; // not allowed with coercion
/// ``` /// ```
/// ///
/// ## 4. Get it from C. /// ## 4. Get it from C.