pub struct CopyTaggedPtr<P, T, const COMPARE_PACKED: bool>where
    P: Pointer,
    T: Tag,{
    packed: NonNull<P::Target>,
    tag_ghost: PhantomData<T>,
}
Expand description

A Copy tagged pointer.

This is essentially { pointer: P, tag: T } packed in a single pointer.

You should use this instead of the TaggedPtr type in all cases where P implements Copy.

If COMPARE_PACKED is true, then the pointers will be compared and hashed without unpacking. Otherwise we don’t implement PartialEq, Eq and Hash; if you want that, wrap the CopyTaggedPtr.

Fields§

§packed: NonNull<P::Target>

This is semantically a pair of pointer: P and tag: T fields, however we pack them in a single pointer, to save space.

We pack the tag into the most-significant bits of the pointer to ease retrieval of the value. A left shift is a multiplication and those are embeddable in instruction encoding, for example:

// (<https://godbolt.org/z/jqcYPWEr3>)
example::shift_read3:
    mov     eax, dword ptr [8*rdi]
    ret

example::mask_read3:
    and     rdi, -8
    mov     eax, dword ptr [rdi]
    ret

This is ASM outputted by rustc for reads of values behind tagged pointers for different approaches of tagging:

  • shift_read3 uses << 3 (the tag is in the most-significant bits)
  • mask_read3 uses & !0b111 (the tag is in the least-significant bits)

The shift approach thus produces less instructions and is likely faster (see https://godbolt.org/z/Y913sMdWb).

Encoding diagram:

[ packed.addr                     ]
[ tag ] [ pointer.addr >> T::BITS ] <-- usize::BITS - T::BITS bits
   ^
   |
T::BITS bits

The tag can be retrieved by packed.addr() >> T::BITS and the pointer can be retrieved by packed.map_addr(|addr| addr << T::BITS).

§tag_ghost: PhantomData<T>

Implementations§

source§

impl<P, T, const CP: bool> CopyTaggedPtr<P, T, CP>where P: Pointer, T: Tag,

source

pub fn new(pointer: P, tag: T) -> Self

Tags pointer with tag.

Note that this leaks pointer: it won’t be dropped when CopyTaggedPtr is dropped. If you have a pointer with a significant drop, use TaggedPtr instead.

source

pub fn pointer(self) -> Pwhere P: Copy,

Retrieves the pointer.

source

pub fn tag(&self) -> T

Retrieves the tag.

source

pub fn set_tag(&mut self, tag: T)

Sets the tag to a new value.

source

const TAG_BIT_SHIFT: u32 = _

source

const ASSERTION: () = _

source

fn pack(ptr: NonNull<P::Target>, tag: T) -> NonNull<P::Target>

Pack pointer ptr that comes from P::into_ptr with a tag, according to self.packed encoding scheme.

source

pub(super) fn pointer_raw(&self) -> NonNull<P::Target>

Retrieves the original raw pointer from self.packed.

source

pub(super) fn with_pointer_ref<R>(&self, f: impl FnOnce(&P) -> R) -> R

This provides a reference to the P pointer itself, rather than the Deref::Target. It is used for cases where we want to call methods that may be implement differently for the Pointer than the Pointee (e.g., Rc::clone vs cloning the inner value).

Trait Implementations§

source§

impl<P, T, const CP: bool> Clone for CopyTaggedPtr<P, T, CP>where P: Pointer + Copy, T: Tag,

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<P, T, const CP: bool> Debug for CopyTaggedPtr<P, T, CP>where P: Pointer + Debug, T: Tag + Debug,

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<P, T, const CP: bool> Deref for CopyTaggedPtr<P, T, CP>where P: Pointer, T: Tag,

§

type Target = <P as Deref>::Target

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl<P, T, const CP: bool> DerefMut for CopyTaggedPtr<P, T, CP>where P: Pointer + DerefMut, T: Tag,

source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
source§

impl<P, T> Hash for CopyTaggedPtr<P, T, true>where P: Pointer, T: Tag,

source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<P, T, HCX, const CP: bool> HashStable<HCX> for CopyTaggedPtr<P, T, CP>where P: Pointer + HashStable<HCX>, T: Tag + HashStable<HCX>,

source§

fn hash_stable(&self, hcx: &mut HCX, hasher: &mut StableHasher)

source§

impl<P, T> PartialEq for CopyTaggedPtr<P, T, true>where P: Pointer, T: Tag,

source§

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<P, T, const CP: bool> Copy for CopyTaggedPtr<P, T, CP>where P: Pointer + Copy, T: Tag,

source§

impl<P, T> Eq for CopyTaggedPtr<P, T, true>where P: Pointer, T: Tag,

source§

impl<P, T, const CP: bool> Send for CopyTaggedPtr<P, T, CP>where P: Send + Pointer, T: Send + Tag,

source§

impl<P, T, const CP: bool> Sync for CopyTaggedPtr<P, T, CP>where P: Sync + Pointer, T: Sync + Tag,

Auto Trait Implementations§

§

impl<P, T, const COMPARE_PACKED: bool> RefUnwindSafe for CopyTaggedPtr<P, T, COMPARE_PACKED>where T: RefUnwindSafe, <P as Deref>::Target: RefUnwindSafe,

§

impl<P, T, const COMPARE_PACKED: bool> Unpin for CopyTaggedPtr<P, T, COMPARE_PACKED>where T: Unpin,

§

impl<P, T, const COMPARE_PACKED: bool> UnwindSafe for CopyTaggedPtr<P, T, COMPARE_PACKED>where T: UnwindSafe, <P as Deref>::Target: RefUnwindSafe,

Blanket Implementations§

source§

impl<T> Aligned for T

source§

const ALIGN: Alignment = const ALIGN: Alignment = Alignment::of::<Self>();

Alignment of Self.
source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<'a, T> Captures<'a> for Twhere T: ?Sized,

Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.