1.25.0[−][src]Struct core::ptr::NonNull  
*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>[src] 
impl<T: Sized> NonNull<T>pub fn dangling() -> Self[src] 
pub fn dangling() -> SelfCreates a new NonNull that is dangling, but well-aligned.
This is useful for initializing types which lazily allocate, like
Vec::new does.
Note that the pointer value may potentially represent a valid pointer to
a T, which means this must not be used as a "not yet initialized"
sentinel value. Types that lazily allocate must track initialization by
some other means.
impl<T: ?Sized> NonNull<T>[src] 
impl<T: ?Sized> NonNull<T>pub const unsafe fn new_unchecked(ptr: *mut T) -> Self[src] 
pub const unsafe fn new_unchecked(ptr: *mut T) -> Selfpub fn new(ptr: *mut T) -> Option<Self>[src] 
pub fn new(ptr: *mut T) -> Option<Self>Creates a new NonNull if ptr is non-null.
pub fn as_ptr(self) -> *mut T[src] 
pub fn as_ptr(self) -> *mut TAcquires the underlying *mut pointer.
pub unsafe fn as_ref(&self) -> &T[src] 
pub unsafe fn as_ref(&self) -> &TDereferences 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[src] 
pub unsafe fn as_mut(&mut self) -> &mut TMutably 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>1.27.0[src] 
pub fn cast<U>(self) -> NonNull<U>Cast to a pointer of another type
Trait Implementations
impl<T: ?Sized> !Send for NonNull<T>[src] 
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>[src] 
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>[src] 
impl<T: ?Sized> Clone for NonNull<T>fn clone(&self) -> Self[src] 
fn clone(&self) -> SelfReturns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src] 
fn clone_from(&mut self, source: &Self)Performs copy-assignment from source. Read more
impl<T: ?Sized> Copy for NonNull<T>[src] 
impl<T: ?Sized> Copy for NonNull<T>impl<T: ?Sized, U: ?Sized> CoerceUnsized<NonNull<U>> for NonNull<T> where
    T: Unsize<U>, [src] 
impl<T: ?Sized, U: ?Sized> CoerceUnsized<NonNull<U>> for NonNull<T> where
    T: Unsize<U>, impl<T: ?Sized> Debug for NonNull<T>[src] 
impl<T: ?Sized> Debug for NonNull<T>fn fmt(&self, f: &mut Formatter) -> Result[src] 
fn fmt(&self, f: &mut Formatter) -> ResultFormats the value using the given formatter. Read more
impl<T: ?Sized> Pointer for NonNull<T>[src] 
impl<T: ?Sized> Pointer for NonNull<T>impl<T: ?Sized> Eq for NonNull<T>[src] 
impl<T: ?Sized> Eq for NonNull<T>impl<T: ?Sized> PartialEq for NonNull<T>[src] 
impl<T: ?Sized> PartialEq for NonNull<T>fn eq(&self, other: &Self) -> bool[src] 
fn eq(&self, other: &Self) -> boolThis method tests for self and other values to be equal, and is used by ==. Read more
#[must_use]
fn ne(&self, other: &Rhs) -> bool1.0.0[src] 
#[must_use]
fn ne(&self, other: &Rhs) -> boolThis method tests for !=.
impl<T: ?Sized> Ord for NonNull<T>[src] 
impl<T: ?Sized> Ord for NonNull<T>fn cmp(&self, other: &Self) -> Ordering[src] 
fn cmp(&self, other: &Self) -> OrderingThis method returns an Ordering between self and other. Read more
fn max(self, other: Self) -> Self where
    Self: Sized, 1.21.0[src] 
fn max(self, other: Self) -> Self where
    Self: Sized, Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self where
    Self: Sized, 1.21.0[src] 
fn min(self, other: Self) -> Self where
    Self: Sized, Compares and returns the minimum of two values. Read more
impl<T: ?Sized> PartialOrd for NonNull<T>[src] 
impl<T: ?Sized> PartialOrd for NonNull<T>fn partial_cmp(&self, other: &Self) -> Option<Ordering>[src] 
fn partial_cmp(&self, other: &Self) -> Option<Ordering>This method returns an ordering between self and other values if one exists. Read more
#[must_use]
fn lt(&self, other: &Rhs) -> bool1.0.0[src] 
#[must_use]
fn lt(&self, other: &Rhs) -> boolThis method tests less than (for self and other) and is used by the < operator. Read more
#[must_use]
fn le(&self, other: &Rhs) -> bool1.0.0[src] 
#[must_use]
fn le(&self, other: &Rhs) -> boolThis method tests less than or equal to (for self and other) and is used by the <= operator. Read more
#[must_use]
fn gt(&self, other: &Rhs) -> bool1.0.0[src] 
#[must_use]
fn gt(&self, other: &Rhs) -> boolThis method tests greater than (for self and other) and is used by the > operator. Read more
#[must_use]
fn ge(&self, other: &Rhs) -> bool1.0.0[src] 
#[must_use]
fn ge(&self, other: &Rhs) -> boolThis method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
impl<T: ?Sized> Hash for NonNull<T>[src] 
impl<T: ?Sized> Hash for NonNull<T>fn hash<H: Hasher>(&self, state: &mut H)[src] 
fn hash<H: Hasher>(&self, state: &mut H)Feeds this value into the given [Hasher]. Read more
fn hash_slice<H: Hasher>(data: &[Self], state: &mut H) where
    Self: Sized, 1.3.0[src] 
fn hash_slice<H: Hasher>(data: &[Self], state: &mut H) where
    Self: Sized, Feeds a slice of this type into the given [Hasher]. Read more
impl<'a, T: ?Sized> From<&'a mut T> for NonNull<T>[src] 
impl<'a, T: ?Sized> From<&'a mut T> for NonNull<T>impl<'a, T: ?Sized> From<&'a T> for NonNull<T>[src] 
impl<'a, T: ?Sized> From<&'a T> for NonNull<T>Blanket Implementations
impl<T, U> Into for T where
    U: From<T>, [src] 
impl<T, U> Into for T where
    U: From<T>, impl<T> From for T[src] 
impl<T> From for Timpl<T, U> TryInto for T where
    U: TryFrom<T>, [src] 
impl<T, U> TryInto for T where
    U: TryFrom<T>, type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(Self) -> Result<U, <U as TryFrom<T>>::Error>[src] 
fn try_into(Self) -> Result<U, <U as TryFrom<T>>::Error>Performs the conversion.
impl<T, U> TryFrom for T where
    T: From<U>, [src] 
impl<T, U> TryFrom for T where
    T: From<U>, type Error = !
The type returned in the event of a conversion error.
fn try_from(U) -> Result<T, <T as TryFrom<U>>::Error>[src] 
fn try_from(U) -> Result<T, <T as TryFrom<U>>::Error>Performs the conversion.
impl<T> Borrow for T where
    T: ?Sized, [src] 
impl<T> Borrow for T where
    T: ?Sized, impl<T> BorrowMut for T where
    T: ?Sized, [src] 
impl<T> BorrowMut for T where
    T: ?Sized, fn borrow_mut(&mut Self) -> &mut T[src] 
fn borrow_mut(&mut Self) -> &mut TMutably borrows from an owned value. Read more
impl<T> Any for T where
    T: 'static + ?Sized, [src] 
impl<T> Any for T where
    T: 'static + ?Sized, fn get_type_id(&Self) -> TypeId[src] 
fn get_type_id(&Self) -> TypeId🔬 This is a nightly-only experimental API.  (get_type_id #27745)
this method will likely be replaced by an associated static
Gets the TypeId of self. Read more