bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

doc fixes

Browse source
This commit is contained in:
Maybe Waffle 2023-04-12 19:00:27 +00:00
parent 838c5491a4
commit dc19dc29c9
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
compiler/rustc_data_structures/src/tagged_ptr.rs
View file

@ -40,11 +40,12 @@ pub use drop::TaggedPtr;
/// [`into_ptr`] must be valid for writes (and thus calling [`NonNull::as_mut`]
/// on it must be safe).
///
/// The `BITS` constant must be correct. At least `BITS` bits, least-significant,
/// must be zero on all pointers returned from [`into_ptr`].
/// The [`BITS`] constant must be correct. At least [`BITS`] least significant
/// bits, must be zero on all pointers returned from [`into_ptr`].
///
/// For example, if the alignment of [`Self::Target`] is 2, then `BITS` should be 1.
///
/// [`BITS`]: Pointer::BITS
/// [`into_ptr`]: Pointer::into_ptr
/// [valid]: std::ptr#safety
/// [`<Self as Deref>::Target`]: Deref::Target
@ -122,7 +123,7 @@ pub unsafe trait Tag: Copy {
/// This function guarantees that only the least-significant [`Self::BITS`]
/// bits can be non-zero.
///
/// [`from_usize`]: Pointer::from_usize
/// [`from_usize`]: Tag::from_usize
/// [`Self::BITS`]: Tag::BITS
fn into_usize(self) -> usize;