Struct core::ptr::NonNull

pub struct NonNull<T: ?Sized> { /* fields omitted */ }

*mut T but non-zero and covariant.

This is often the correct thing to use when building data structures using raw pointers, but is ultimately more dangerous to use because of its additional properties. If you're not sure if you should use NonNull<T>, just use *mut T!

Unlike *mut T, the pointer must always be non-null, even if the pointer is never dereferenced. This is so that enums may use this forbidden value as a discriminant -- Option<NonNull<T>> has the same size as *mut T. However the pointer may still dangle if it isn't dereferenced.

Unlike *mut T, NonNull<T> is covariant over T. If this is incorrect for your use case, you should include some PhantomData in your type to provide invariance, such as PhantomData<Cell<T>> or PhantomData<&'a mut T>. Usually this won't be necessary; covariance is correct for most safe abstractions, such as Box, Rc, Arc, Vec, and LinkedList. This is the case because they provide a public API that follows the normal shared XOR mutable rules of Rust.

Methods

impl<T: Sized> NonNull<T>

pub fn dangling() -> Self

Creates a new NonNull that is dangling, but well-aligned.

This is useful for initializing types which lazily allocate, like Vec::new does.

impl<T: ?Sized> NonNull<T>

pub const unsafe fn new_unchecked(ptr: *mut T) -> Self

Creates a new NonNull.

Safety

ptr must be non-null.

pub fn new(ptr: *mut T) -> Option<Self>

Creates a new NonNull if ptr is non-null.

pub fn as_ptr(self) -> *mut T

Acquires the underlying *mut pointer.

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

Dereferences the content.

The resulting lifetime is bound to self so this behaves "as if" it were actually an instance of T that is getting borrowed. If a longer (unbound) lifetime is needed, use &*my_ptr.as_ptr().

pub unsafe fn as_mut(&mut self) -> &mut T

Mutably dereferences the content.

The resulting lifetime is bound to self so this behaves "as if" it were actually an instance of T that is getting borrowed. If a longer (unbound) lifetime is needed, use &mut *my_ptr.as_ptr().

pub fn cast<U>(self) -> NonNull<U>

Cast to a pointer of another type

pub fn as_opaque(self) -> NonNull<Opaque>

🔬 This is a nightly-only experimental API. (allocator_api #32838)

Cast to an Opaque pointer

Trait Implementations

impl<T: ?Sized> !Send for NonNull<T>

NonNull pointers are not Send because the data they reference may be aliased.

impl<T: ?Sized> !Sync for NonNull<T>

NonNull pointers are not Sync because the data they reference may be aliased.

impl<T: ?Sized> Clone for NonNull<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized> Copy for NonNull<T>

impl<T: ?Sized, U: ?Sized> CoerceUnsized<NonNull<U>> for NonNull<T> where     T: Unsize<U>,

impl<T: ?Sized> Debug for NonNull<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Pointer for NonNull<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Eq for NonNull<T>

impl<T: ?Sized> PartialEq for NonNull<T>

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

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

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

This method tests for !=.

impl<T: ?Sized> Ord for NonNull<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.

impl<T: ?Sized> PartialOrd for NonNull<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

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

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

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

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

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

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

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

impl<T: ?Sized> Hash for NonNull<T>

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

Feeds this value into the given [Hasher].

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

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

impl<'a, T: ?Sized> From<&'a mut T> for NonNull<T>

fn from(reference: &'a mut T) -> Self

Performs the conversion.

impl<'a, T: ?Sized> From<&'a T> for NonNull<T>

fn from(reference: &'a T) -> Self

Performs the conversion.