Struct TaggedNonNull 

pub struct TaggedNonNull<T: ?Sized>(/* private fields */);

A [NonNull<T>] pointer with a numerical tag.

The tag is split between the low alignment bits of the inner type, and the high order bits that are free due to the architecture virtual address width.

Implementations

impl<T> TaggedNonNull<T>

pub const TAG_HIGH_BITS: u32 = 16

pub const TAG_LOW_BITS: u32

pub const MAXIMUM_TAG: usize

The (architecture- and type-dependent) maximum value the tag can hold.

pub fn new(ptr: NonNull<T>, tag: usize) -> Self

Create a new TaggedNonNull with the given tag.

pub fn as_ptr(&self) -> NonNull<T>

Extract the pointer portion of the TaggedNonNull.

pub fn tag(&self) -> usize

Extract the tag portion of the TaggedNonNull.

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

Compares the addresses of the two pointers for equality, ignoring the tag value.

pub fn as_tagged_ptr(&self) -> NonNull<T>

pub fn from_tagged_ptr(ptr: NonNull<T>) -> Self

Trait Implementations

impl<T: Clone + ?Sized> Clone for TaggedNonNull<T>

fn clone(&self) -> TaggedNonNull<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy + ?Sized> Copy for TaggedNonNull<T>

impl<T: Debug + ?Sized> Debug for TaggedNonNull<T>

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

Formats the value using the given formatter.

impl<T: Eq + ?Sized> Eq for TaggedNonNull<T>

impl<T: Hash + ?Sized> Hash for TaggedNonNull<T>

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

Feeds this value into the given [Hasher].

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given [Hasher].

impl<T: Ord + ?Sized> Ord for TaggedNonNull<T>

fn cmp(&self, other: &TaggedNonNull<T>) -> Ordering

This method returns an [Ordering] between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<T: PartialEq + ?Sized> PartialEq for TaggedNonNull<T>

fn eq(&self, other: &TaggedNonNull<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd + ?Sized> PartialOrd for TaggedNonNull<T>

fn partial_cmp(&self, other: &TaggedNonNull<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Pointer for TaggedNonNull<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + ?Sized> StructuralPartialEq for TaggedNonNull<T>