diff options
| author | bstrie <865233+bstrie@users.noreply.github.com> | 2022-05-03 11:57:24 -0400 |
|---|---|---|
| committer | bstrie <865233+bstrie@users.noreply.github.com> | 2022-05-03 11:57:24 -0400 |
| commit | 6096cfbfffdaebd5eca5e0816086e31f10de7eb8 (patch) | |
| tree | 263588867dab47bb48b39ccebdb29d71114e18ed | |
| parent | e1df625306f4136949e02612406f0c60df6008f3 (diff) | |
| download | rust-6096cfbfffdaebd5eca5e0816086e31f10de7eb8.tar.gz rust-6096cfbfffdaebd5eca5e0816086e31f10de7eb8.zip | |
docs: add link explaining variance to NonNull docs
| -rw-r--r-- | library/core/src/ptr/non_null.rs | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/library/core/src/ptr/non_null.rs b/library/core/src/ptr/non_null.rs index 5ebe6150906..9946db67db9 100644 --- a/library/core/src/ptr/non_null.rs +++ b/library/core/src/ptr/non_null.rs @@ -9,7 +9,7 @@ use crate::ops::{CoerceUnsized, DispatchFromDyn}; use crate::ptr::Unique; use crate::slice::{self, SliceIndex}; -/// `*mut T` but non-zero and covariant. +/// `*mut T` but non-zero and [covariant]. /// /// This is often the correct thing to use when building data structures using /// raw pointers, but is ultimately more dangerous to use because of its additional @@ -42,6 +42,7 @@ use crate::slice::{self, SliceIndex}; /// it is your responsibility to ensure that `as_mut` is never called, and `as_ptr` /// is never used for mutation. /// +/// [covariant]: https://doc.rust-lang.org/reference/subtyping.html /// [`PhantomData`]: crate::marker::PhantomData /// [`UnsafeCell<T>`]: crate::cell::UnsafeCell #[stable(feature = "nonnull", since = "1.25.0")] |