Struct Ptr 

pub struct Ptr<T> { /* private fields */ }

A transparent wrapper around Option<NonNull<T>> returned by AtomicTaggedPtr operations.

It provides convenient helper methods to convert into raw const/mutable pointers, access the underlying Option<NonNull<T>>, and supports direct comparisons.

Implementations

impl<T> Ptr<T>

pub const fn new(ptr: Option<NonNull<T>>) -> Self

Creates a new Ptr wrapper from an Option<NonNull<T>>.

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 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 const fn option(self) -> Option<NonNull<T>>

Obtains the underlying Option<NonNull<T>>.

pub const fn as_option(self) -> Option<NonNull<T>>

Obtains the underlying Option<NonNull<T>>.

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 expect(self, msg: &str) -> NonNull<T>

Unwraps the inner NonNull<T>, panicking with the given message if it is None.

pub fn unwrap(self) -> NonNull<T>

Unwraps the inner NonNull<T>, panicking if it is None.

pub fn unwrap_or(self, default: NonNull<T>) -> NonNull<T>

Returns the contained NonNull<T> or a default.

pub fn map<U, F>(self, f: F) -> Ptr<U>

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

Maps the inner NonNull<T> pointer to a new pointer of another type.

pub fn map_or<U, F>(self, default: U, f: F) -> U

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

Maps the inner NonNull<T> pointer to a value, or returns a default value.

pub fn map_or_else<U, D, F>(self, default: D, f: F) -> U

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

Maps the inner NonNull<T> pointer to a value, or evaluates a default closure.

Trait Implementations

impl<T> Clone for Ptr<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 Ptr<T>

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

Formats the value using the given formatter.

impl<T> Default for Ptr<T>

fn default() -> Self

Returns the “default value” for a type.

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

fn from(ptr: *const T) -> Self

Converts to this type from the input type.

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

fn from(ptr: *mut T) -> Self

Converts to this type from the input type.

impl<T> From<NonNull<T>> for Ptr<T>

fn from(ptr: NonNull<T>) -> Self

Converts to this type from the input type.

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

fn from(ptr: Option<NonNull<T>>) -> Self

Converts to this type from the input type.

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

fn from(ptr: Ptr<T>) -> Self

Converts to this type from the input type.

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

fn from(ptr: Ptr<T>) -> Self

Converts to this type from the input type.

impl<T> From<Ptr<T>> for Option<*const T>

fn from(ptr: Ptr<T>) -> Self

Converts to this type from the input type.

impl<T> From<Ptr<T>> for Option<*mut T>

fn from(ptr: Ptr<T>) -> Self

Converts to this type from the input type.

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

fn from(ptr: Ptr<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 Ptr<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 Ptr<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<*const T> for Ptr<T>

fn eq(&self, other: &*const T) -> 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> PartialEq<*mut T> for Ptr<T>

fn eq(&self, other: &*mut T) -> 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> PartialEq<NonNull<T>> for Ptr<T>

fn eq(&self, other: &NonNull<T>) -> 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> PartialEq<Option<NonNull<T>>> for Ptr<T>

fn eq(&self, other: &Option<NonNull<T>>) -> 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> PartialEq for Ptr<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 Ptr<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 Ptr<T>

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

Formats the value using the given formatter.

impl<T> Copy for Ptr<T>

impl<T> Eq for Ptr<T>