Struct TaggedPtr 

pub struct TaggedPtr<T> {
    pub ptr: Ptr<T>,
    pub tag: Tag,
}

A packaged representation of a pointer and a generation tag. Used for atomic operations with AtomicTaggedPtr.

Fields

ptr: Ptr<T>

The physical pointer wrapper.

tag: Tag

The generation tag for ABA protection.

Implementations

impl<T> TaggedPtr<T>

pub fn new<P>(ptr: P, tag: Tag) -> Self

where P: Into<Ptr<T>>,

Creates a new TaggedPtr from a pointer and a tag.

pub fn decompose(self) -> (Ptr<T>, Tag)

Deconstructs the TaggedPtr into a tuple of (Ptr<T>, Tag).

pub fn as_ptr(self) -> *const T

Converts the pointer into a raw const pointer *const T. Returns a null pointer if the underlying value is None.

pub fn as_mut_ptr(self) -> *mut T

Converts the pointer into a raw mutable pointer *mut T. Returns a null pointer if the underlying value is None.

pub fn is_null(self) -> bool

Returns true if the pointer is null.

pub fn is_some(self) -> bool

Returns true if the pointer is not null (is some).

pub fn is_none(self) -> bool

Returns true if the pointer is null (is none).

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

Returns a shared reference to the value if the pointer is not null.

Safety

The caller must ensure that the pointer is valid, aligned, points to a valid initialized value, and respects the aliasing rules of Rust references.

pub unsafe fn as_mut<'a>(self) -> Option<&'a mut T>

Returns a mutable reference to the value if the pointer is not null.

Safety

The caller must ensure that the pointer is valid, aligned, points to a valid initialized value, and respects the aliasing rules of Rust references.

pub fn with_ptr<U>(self, ptr: impl Into<Ptr<U>>) -> TaggedPtr<U>

Returns a new TaggedPtr with a different pointer but the same tag.

pub fn with_tag(self, tag: Tag) -> Self

Returns a new TaggedPtr with a different tag but the same pointer.

pub fn map_ptr<U, F>(self, f: F) -> TaggedPtr<U>

where F: FnOnce(Ptr<T>) -> Ptr<U>,

Maps the pointer part of the TaggedPtr using the given closure.

Trait Implementations

impl<T> Clone for TaggedPtr<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for TaggedPtr<T>

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

Formats the value using the given formatter.

impl<T> Default for TaggedPtr<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> From<(*const T, Tag)> for TaggedPtr<T>

fn from(tuple: (*const T, Tag)) -> Self

Converts to this type from the input type.

impl<T> From<(*mut T, Tag)> for TaggedPtr<T>

fn from(tuple: (*mut T, Tag)) -> Self

Converts to this type from the input type.

impl<T> From<(NonNull<T>, Tag)> for TaggedPtr<T>

fn from(tuple: (NonNull<T>, Tag)) -> Self

Converts to this type from the input type.

impl<T> From<(Option<NonNull<T>>, Tag)> for TaggedPtr<T>

fn from(tuple: (Option<NonNull<T>>, Tag)) -> Self

Converts to this type from the input type.

impl<T> From<(Ptr<T>, Tag)> for TaggedPtr<T>

fn from(tuple: (Ptr<T>, Tag)) -> Self

Converts to this type from the input type.

impl<T> From<TaggedPtr<T>> for (Ptr<T>, Tag)

fn from(tagged: TaggedPtr<T>) -> Self

Converts to this type from the input type.

impl<T> From<TaggedPtr<T>> for *const T

fn from(tagged: TaggedPtr<T>) -> Self

Converts to this type from the input type.

impl<T> From<TaggedPtr<T>> for *mut T

fn from(tagged: TaggedPtr<T>) -> Self

Converts to this type from the input type.

impl<T> From<TaggedPtr<T>> for AtomicTaggedPtr<T>

fn from(val: TaggedPtr<T>) -> Self

Converts to this type from the input type.

impl<T> From<TaggedPtr<T>> for Option<NonNull<T>>

fn from(tagged: TaggedPtr<T>) -> Self

Converts to this type from the input type.

impl<T> From<TaggedPtr<T>> for Ptr<T>

fn from(tagged: TaggedPtr<T>) -> Self

Converts to this type from the input type.

impl<T> Hash for TaggedPtr<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 for TaggedPtr<T>

fn cmp(&self, other: &Self) -> 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.

impl<T> PartialEq for TaggedPtr<T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialOrd for TaggedPtr<T>

fn partial_cmp(&self, other: &Self) -> 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 TaggedPtr<T>

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

Formats the value using the given formatter.

impl<T> Copy for TaggedPtr<T>

impl<T> Eq for TaggedPtr<T>