Struct tagged_box::TaggedPointer

#[repr(transparent)]
pub struct TaggedPointer { /* fields omitted */ }

A pointer that holds a data pointer plus additional data stored as a Discriminant
Note: The discriminant must be <= MAX_DISCRIMINANT, which is feature-dependent

Methods

impl TaggedPointer

pub fn new(ptr: usize, discriminant: Discriminant) -> Self

Create a new tagged pointer from a pointer and a discriminant

Panics

Panics if discriminant is greater than MAX_DISCRIMINANT or if ptr is greater than MAX_POINTER_VALUE

pub unsafe fn new_unchecked(ptr: usize, discriminant: Discriminant) -> Self

Create a new tagged pointer from a pointer and a discriminant without checking invariance

Safety

discriminant must be <= MAX_DISCRIMINANT and pointer must be <= MAX_POINTER_VALUE

pub const fn discriminant(self) -> Discriminant

Fetches the discriminant of the tagged pointer

pub unsafe fn as_ref<T>(&self) -> &T

Gains a reference to the inner value of the pointer

Safety

The pointer given to TaggedPointer::new must be properly aligned and non-null

pub unsafe fn as_mut_ref<T>(&mut self) -> &mut T

Gains a mutable reference to the inner value of the pointer

Safety

The pointer given to TaggedPointer::new must be properly aligned and non-null

pub const fn as_usize(self) -> usize

Returns the pointer as a usize, removing the discriminant

pub const fn as_raw_usize(self) -> usize

Returns the raw tagged pointer, without removing the discriminant

Warning

Attempting to dereference this usize will not point to valid memory!

pub const fn as_ptr<T>(self) -> *const T

Converts a tagged pointer into a raw pointer, removing the discriminant

pub fn as_mut_ptr<T>(self) -> *mut T

Converts a tagged pointer into a raw pointer, removing the discriminant

pub fn store_discriminant(pointer: usize, discriminant: Discriminant) -> usize

Store a Discriminant into a tagged pointer

Panics

Panics if discriminant is greater than MAX_DISCRIMINANT or if ptr is greater than MAX_POINTER_VALUE

pub unsafe fn store_discriminant_unchecked(
    pointer: usize,
    discriminant: Discriminant
) -> usize

Store a Discriminant into a tagged pointer without any checks

Safety

discriminant must be <= MAX_DISCRIMINANT and pointer must be <= MAX_POINTER_VALUE

pub const fn fetch_discriminant(pointer: usize) -> Discriminant

Fetch a Discriminant from a tagged pointer

pub const fn strip_discriminant(pointer: usize) -> usize

Strip the Discriminant from a tagged pointer, returning only the valid pointer as a usize

Trait Implementations

impl Binary for TaggedPointer

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

Formats the value using the given formatter.

impl Clone for TaggedPointer

fn clone(&self) -> TaggedPointer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TaggedPointer

impl Debug for TaggedPointer

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

Formats the value using the given formatter.

impl Eq for TaggedPointer

impl Hash for TaggedPointer

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, 

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

impl LowerHex for TaggedPointer

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

Formats the value using the given formatter.

impl Octal for TaggedPointer

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

Formats the value using the given formatter.

impl Ord for TaggedPointer

fn cmp(&self, other: &TaggedPointer) -> Ordering

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

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<TaggedPointer> for TaggedPointer

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

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

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

This method tests for !=.

impl PartialOrd<TaggedPointer> for TaggedPointer

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Pointer for TaggedPointer

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

Formats the value using the given formatter.

impl StructuralEq for TaggedPointer

impl StructuralPartialEq for TaggedPointer

impl UpperHex for TaggedPointer

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

Formats the value using the given formatter.