nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-24 15:54:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use intra-doc links in core::ptr

Browse Source 
The only link that I did not change is a link to a function on the
`pointer` primitive because intra-doc links for the `pointer` primitive
don't work yet (see #63351).
This commit is contained in:
Camelid 2020-09-08 14:36:36 -07:00
parent 5099914a16
commit 325acefee4
1 changed files with 21 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
library/core/src/ptr/mod.rs
View File

@ -54,16 +54,9 @@
//! [aliasing]: ../../nomicon/aliasing.html //! [aliasing]: ../../nomicon/aliasing.html
//! [book]: ../../book/ch19-01-unsafe-rust.html#dereferencing-a-raw-pointer //! [book]: ../../book/ch19-01-unsafe-rust.html#dereferencing-a-raw-pointer
//! [ub]: ../../reference/behavior-considered-undefined.html //! [ub]: ../../reference/behavior-considered-undefined.html
//! [null]: ./fn.null.html
//! [zst]: ../../nomicon/exotic-sizes.html#zero-sized-types-zsts //! [zst]: ../../nomicon/exotic-sizes.html#zero-sized-types-zsts
//! [atomic operations]: ../../std/sync/atomic/index.html //! [atomic operations]: crate::sync::atomic
//! [`copy`]: ../../std/ptr/fn.copy.html
//! [`offset`]: ../../std/primitive.pointer.html#method.offset //! [`offset`]: ../../std/primitive.pointer.html#method.offset
//! [`read_unaligned`]: ./fn.read_unaligned.html
//! [`write_unaligned`]: ./fn.write_unaligned.html
//! [`read_volatile`]: ./fn.read_volatile.html
//! [`write_volatile`]: ./fn.write_volatile.html
//! [`NonNull::dangling`]: ./struct.NonNull.html#method.dangling
#![stable(feature = "rust1", since = "1.0.0")] #![stable(feature = "rust1", since = "1.0.0")]
@ -118,9 +111,9 @@ mod mut_ptr;
/// done automatically by the compiler. This means the fields of packed structs /// done automatically by the compiler. This means the fields of packed structs
/// are not dropped in-place. /// are not dropped in-place.
/// ///
/// [`ptr::read`]: ../ptr/fn.read.html /// [`ptr::read`]: self::read
/// [`ptr::read_unaligned`]: ../ptr/fn.read_unaligned.html /// [`ptr::read_unaligned`]: self::read_unaligned
/// [pinned]: ../pin/index.html /// [pinned]: crate::pin
/// ///
/// # Safety /// # Safety
/// ///
@ -141,9 +134,7 @@ mod mut_ptr;
/// ///
/// Note that even if `T` has size `0`, the pointer must be non-NULL and properly aligned. /// Note that even if `T` has size `0`, the pointer must be non-NULL and properly aligned.
/// ///
/// [valid]: ../ptr/index.html#safety /// [valid]: #safety
/// [`Copy`]: ../marker/trait.Copy.html
/// [`write`]: ../ptr/fn.write.html
/// ///
/// # Examples /// # Examples
/// ///
@ -243,9 +234,9 @@ pub(crate) struct FatPtr<T> {
/// The `len` argument is the number of **elements**, not the number of bytes. /// The `len` argument is the number of **elements**, not the number of bytes.
/// ///
/// This function is safe, but actually using the return value is unsafe. /// This function is safe, but actually using the return value is unsafe.
/// See the documentation of [`from_raw_parts`] for slice safety requirements. /// See the documentation of [`slice::from_raw_parts`] for slice safety requirements.
/// ///
/// [`from_raw_parts`]: ../../std/slice/fn.from_raw_parts.html /// [`slice::from_raw_parts`]: crate::slice::from_raw_parts
/// ///
/// # Examples /// # Examples
/// ///
@ -274,10 +265,9 @@ pub const fn slice_from_raw_parts<T>(data: *const T, len: usize) -> *const [T] {
/// See the documentation of [`slice_from_raw_parts`] for more details. /// See the documentation of [`slice_from_raw_parts`] for more details.
/// ///
/// This function is safe, but actually using the return value is unsafe. /// This function is safe, but actually using the return value is unsafe.
/// See the documentation of [`from_raw_parts_mut`] for slice safety requirements. /// See the documentation of [`slice::from_raw_parts_mut`] for slice safety requirements.
/// ///
/// [`slice_from_raw_parts`]: fn.slice_from_raw_parts.html /// [`slice::from_raw_parts_mut`]: crate::slice::from_raw_parts_mut
/// [`from_raw_parts_mut`]: ../../std/slice/fn.from_raw_parts_mut.html
/// ///
/// # Examples /// # Examples
/// ///
@ -316,8 +306,6 @@ pub const fn slice_from_raw_parts_mut<T>(data: *mut T, len: usize) -> *mut [T] {
/// overlapping region of memory from `x` will be used. This is demonstrated /// overlapping region of memory from `x` will be used. This is demonstrated
/// in the second example below. /// in the second example below.
/// ///
/// [`mem::swap`]: ../mem/fn.swap.html
///
/// # Safety /// # Safety
/// ///
/// Behavior is undefined if any of the following conditions are violated: /// Behavior is undefined if any of the following conditions are violated:
@ -328,7 +316,7 @@ pub const fn slice_from_raw_parts_mut<T>(data: *mut T, len: usize) -> *mut [T] {
/// ///
/// Note that even if `T` has size `0`, the pointers must be non-NULL and properly aligned. /// Note that even if `T` has size `0`, the pointers must be non-NULL and properly aligned.
/// ///
/// [valid]: ../ptr/index.html#safety /// [valid]: #safety
/// ///
/// # Examples /// # Examples
/// ///
@ -406,7 +394,7 @@ pub unsafe fn swap<T>(x: *mut T, y: *mut T) {
/// Note that even if the effectively copied size (`count * size_of::<T>()`) is `0`, /// Note that even if the effectively copied size (`count * size_of::<T>()`) is `0`,
/// the pointers must be non-NULL and properly aligned. /// the pointers must be non-NULL and properly aligned.
/// ///
/// [valid]: ../ptr/index.html#safety /// [valid]: #safety
/// ///
/// # Examples /// # Examples
/// ///
@ -533,8 +521,6 @@ unsafe fn swap_nonoverlapping_bytes(x: *mut u8, y: *mut u8, len: usize) {
/// operates on raw pointers instead of references. When references are /// operates on raw pointers instead of references. When references are
/// available, [`mem::replace`] should be preferred. /// available, [`mem::replace`] should be preferred.
/// ///
/// [`mem::replace`]: ../mem/fn.replace.html
///
/// # Safety /// # Safety
/// ///
/// Behavior is undefined if any of the following conditions are violated: /// Behavior is undefined if any of the following conditions are violated:
@ -547,7 +533,7 @@ unsafe fn swap_nonoverlapping_bytes(x: *mut u8, y: *mut u8, len: usize) {
/// ///
/// Note that even if `T` has size `0`, the pointer must be non-NULL and properly aligned. /// Note that even if `T` has size `0`, the pointer must be non-NULL and properly aligned.
/// ///
/// [valid]: ../ptr/index.html#safety /// [valid]: #safety
/// ///
/// # Examples /// # Examples
/// ///
@ -682,11 +668,7 @@ pub unsafe fn replace<T>(dst: *mut T, mut src: T) -> T {
/// assert_eq!(s, "bar"); /// assert_eq!(s, "bar");
/// ``` /// ```
/// ///
/// [`mem::swap`]: ../mem/fn.swap.html /// [valid]: #safety
/// [valid]: ../ptr/index.html#safety
/// [`Copy`]: ../marker/trait.Copy.html
/// [`read_unaligned`]: ./fn.read_unaligned.html
/// [`write`]: ./fn.write.html
#[inline] #[inline]
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
pub unsafe fn read<T>(src: *const T) -> T { pub unsafe fn read<T>(src: *const T) -> T {
@ -723,11 +705,8 @@ pub unsafe fn read<T>(src: *const T) -> T {
/// ///
/// Note that even if `T` has size `0`, the pointer must be non-NULL. /// Note that even if `T` has size `0`, the pointer must be non-NULL.
/// ///
/// [`Copy`]: ../marker/trait.Copy.html /// [read-ownership]: read#ownership-of-the-returned-value
/// [`read`]: ./fn.read.html /// [valid]: #safety
/// [`write_unaligned`]: ./fn.write_unaligned.html
/// [read-ownership]: ./fn.read.html#ownership-of-the-returned-value
/// [valid]: ../ptr/index.html#safety
/// ///
/// ## On `packed` structs /// ## On `packed` structs
/// ///
@ -819,8 +798,6 @@ pub unsafe fn read_unaligned<T>(src: *const T) -> T {
/// This is appropriate for initializing uninitialized memory, or overwriting /// This is appropriate for initializing uninitialized memory, or overwriting
/// memory that has previously been [`read`] from. /// memory that has previously been [`read`] from.
/// ///
/// [`read`]: ./fn.read.html
///
/// # Safety /// # Safety
/// ///
/// Behavior is undefined if any of the following conditions are violated: /// Behavior is undefined if any of the following conditions are violated:
@ -832,8 +809,7 @@ pub unsafe fn read_unaligned<T>(src: *const T) -> T {
/// ///
/// Note that even if `T` has size `0`, the pointer must be non-NULL and properly aligned. /// Note that even if `T` has size `0`, the pointer must be non-NULL and properly aligned.
/// ///
/// [valid]: ../ptr/index.html#safety /// [valid]: #safety
/// [`write_unaligned`]: ./fn.write_unaligned.html
/// ///
/// # Examples /// # Examples
/// ///
@ -888,8 +864,6 @@ pub unsafe fn read_unaligned<T>(src: *const T) -> T {
/// assert_eq!(foo, "bar"); /// assert_eq!(foo, "bar");
/// assert_eq!(bar, "foo"); /// assert_eq!(bar, "foo");
/// ``` /// ```
///
/// [`mem::swap`]: ../mem/fn.swap.html
#[inline] #[inline]
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
pub unsafe fn write<T>(dst: *mut T, src: T) { pub unsafe fn write<T>(dst: *mut T, src: T) {
@ -916,9 +890,6 @@ pub unsafe fn write<T>(dst: *mut T, src: T) {
/// This is appropriate for initializing uninitialized memory, or overwriting /// This is appropriate for initializing uninitialized memory, or overwriting
/// memory that has previously been read with [`read_unaligned`]. /// memory that has previously been read with [`read_unaligned`].
/// ///
/// [`write`]: ./fn.write.html
/// [`read_unaligned`]: ./fn.read_unaligned.html
///
/// # Safety /// # Safety
/// ///
/// Behavior is undefined if any of the following conditions are violated: /// Behavior is undefined if any of the following conditions are violated:
@ -927,7 +898,7 @@ pub unsafe fn write<T>(dst: *mut T, src: T) {
/// ///
/// Note that even if `T` has size `0`, the pointer must be non-NULL. /// Note that even if `T` has size `0`, the pointer must be non-NULL.
/// ///
/// [valid]: ../ptr/index.html#safety /// [valid]: #safety
/// ///
/// ## On `packed` structs /// ## On `packed` structs
/// ///
@ -1007,8 +978,6 @@ pub unsafe fn write_unaligned<T>(dst: *mut T, src: T) {
/// to not be elided or reordered by the compiler across other volatile /// to not be elided or reordered by the compiler across other volatile
/// operations. /// operations.
/// ///
/// [`write_volatile`]: ./fn.write_volatile.html
///
/// # Notes /// # Notes
/// ///
/// Rust does not currently have a rigorously and formally defined memory model, /// Rust does not currently have a rigorously and formally defined memory model,
@ -1041,10 +1010,8 @@ pub unsafe fn write_unaligned<T>(dst: *mut T, src: T) {
/// ///
/// Note that even if `T` has size `0`, the pointer must be non-NULL and properly aligned. /// Note that even if `T` has size `0`, the pointer must be non-NULL and properly aligned.
/// ///
/// [valid]: ../ptr/index.html#safety /// [valid]: #safety
/// [`Copy`]: ../marker/trait.Copy.html /// [read-ownership]: read#ownership-of-the-returned-value
/// [`read`]: ./fn.read.html
/// [read-ownership]: ./fn.read.html#ownership-of-the-returned-value
/// ///
/// Just like in C, whether an operation is volatile has no bearing whatsoever /// Just like in C, whether an operation is volatile has no bearing whatsoever
/// on questions involving concurrent access from multiple threads. Volatile /// on questions involving concurrent access from multiple threads. Volatile
@ -1089,8 +1056,6 @@ pub unsafe fn read_volatile<T>(src: *const T) -> T {
/// Additionally, it does not drop `src`. Semantically, `src` is moved into the /// Additionally, it does not drop `src`. Semantically, `src` is moved into the
/// location pointed to by `dst`. /// location pointed to by `dst`.
/// ///
/// [`read_volatile`]: ./fn.read_volatile.html
///
/// # Notes /// # Notes
/// ///
/// Rust does not currently have a rigorously and formally defined memory model, /// Rust does not currently have a rigorously and formally defined memory model,
@ -1115,12 +1080,12 @@ pub unsafe fn read_volatile<T>(src: *const T) -> T {
/// ///
/// Note that even if `T` has size `0`, the pointer must be non-NULL and properly aligned. /// Note that even if `T` has size `0`, the pointer must be non-NULL and properly aligned.
/// ///
/// [valid]: ../ptr/index.html#safety /// [valid]: #safety
/// ///
/// Just like in C, whether an operation is volatile has no bearing whatsoever /// Just like in C, whether an operation is volatile has no bearing whatsoever
/// on questions involving concurrent access from multiple threads. Volatile /// on questions involving concurrent access from multiple threads. Volatile
/// accesses behave exactly like non-atomic accesses in that regard. In particular, /// accesses behave exactly like non-atomic accesses in that regard. In particular,
/// a race between a `write_volatile` and any other operation (reading or writing) /// a race between a [`write_volatile`] and any other operation (reading or writing)
/// on the same location is undefined behavior. /// on the same location is undefined behavior.
/// ///
/// # Examples /// # Examples