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).

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> 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> IntoOptionNonNull<T> for Ptr<T>

fn into_option_non_null(self) -> Option<NonNull<T>>

Converts self into Option<NonNull<T>>.

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> Copy for Ptr<T>

impl<T> Eq for Ptr<T>