Struct NonNullMut 

pub struct NonNullMut<T>(/* private fields */)
where
    T: ?Sized;

A wrapper around NonNull that is explicitly a mut pointer.

Implementations

impl<T> NonNullMut<T>

where T: ?Sized,

pub const fn into_nonnull(self) -> NonNull<T>

Convert into a plain NonNull.

pub const fn as_nonnull(&self) -> &NonNull<T>

Take a reference to the internal NonNull.

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

Creates a new NonNullMut.

Safety

ptr must be non-null.

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

Creates a new NonNullMut if ptr is non-null.

pub fn from_mut(r: &mut T) -> Self

Converts a mutable reference to a NonNullMut pointer.

pub const fn as_ptr(&self) -> *mut T

Acquires the underlying *const pointer.

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

Returns an unique reference to the value.

Safety

When calling this method, you have to ensure that the pointer is convertible to a reference.

pub const fn cast<U>(self) -> NonNullMut<U>

Casts to a pointer of another type.

pub const fn cast_const(self) -> NonNullConst<T>

Casts to a const pointer of the same type.

impl NonNullMut<c_void>

pub const unsafe fn new_void_unchecked<U>(ptr: *mut U) -> Self

where U: ?Sized,

Creates a new NonNullMut, casting the passsed pointer to void pointer.

Safety

ptr must be non-null.

pub fn new_void<U>(ptr: *mut U) -> Option<Self>

where U: ?Sized,

Creates a new NonNullMut if ptr is non-null, casting the pointer to a void pointer.

Trait Implementations

impl<T> Clone for NonNullMut<T>

where T: ?Sized,

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 NonNullMut<T>

where T: ?Sized,

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

Formats the value using the given formatter.

impl<T> From<&mut T> for NonNullMut<T>

where T: ?Sized,

fn from(r: &mut T) -> Self

Converts a &mut T to a NonNullMut<T>.

This conversion is safe and infallible since references cannot be null.

impl<T> Hash for NonNullMut<T>

where T: ?Sized,

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 NonNullMut<T>

where T: ?Sized,

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 NonNullMut<T>

where T: ?Sized,

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 NonNullMut<T>

where T: ?Sized,

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 NonNullMut<T>

where T: ?Sized,

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

Formats the value using the given formatter.

impl<T> Copy for NonNullMut<T>

where T: ?Sized,

impl<T> Eq for NonNullMut<T>

where T: ?Sized,