Struct core::nonzero::NonZero

#[lang = "non_zero"]
pub struct NonZero<T: Zeroable>(_);

🔬 This is a nightly-only experimental API. (nonzero #27730)

needs an RFC to flesh out the design

A wrapper type for raw pointers and integers that will never be NULL or 0 that might allow certain optimizations.

Methods

impl<T: Zeroable> NonZero<T>

pub const unsafe fn new_unchecked(inner: T) -> Self

🔬 This is a nightly-only experimental API. (nonzero #27730)

needs an RFC to flesh out the design

Creates an instance of NonZero with the provided value. You must indeed ensure that the value is actually "non-zero".

pub fn new(inner: T) -> Option<Self>

🔬 This is a nightly-only experimental API. (nonzero #27730)

needs an RFC to flesh out the design

Creates an instance of NonZero with the provided value.

pub fn get(self) -> T

🔬 This is a nightly-only experimental API. (nonzero #27730)

needs an RFC to flesh out the design

Gets the inner value.

Trait Implementations

impl<T: Copy + Zeroable> Copy for NonZero<T>

impl<T: Clone + Zeroable> Clone for NonZero<T>

fn clone(&self) -> NonZero<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Eq + Zeroable> Eq for NonZero<T>

impl<T: PartialEq + Zeroable> PartialEq for NonZero<T>

fn eq(&self, __arg_0: &NonZero<T>) -> bool

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

fn ne(&self, __arg_0: &NonZero<T>) -> bool

This method tests for !=.

impl<T: Ord + Zeroable> Ord for NonZero<T>

fn cmp(&self, __arg_0: &NonZero<T>) -> 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: PartialOrd + Zeroable> PartialOrd for NonZero<T>

fn partial_cmp(&self, __arg_0: &NonZero<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &NonZero<T>) -> bool

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

fn le(&self, __arg_0: &NonZero<T>) -> bool

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

fn gt(&self, __arg_0: &NonZero<T>) -> bool

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

fn ge(&self, __arg_0: &NonZero<T>) -> bool

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

impl<T: Debug + Zeroable> Debug for NonZero<T>

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

Formats the value using the given formatter.

impl<T: Hash + Zeroable> Hash for NonZero<T>

fn hash<__HT: Hasher>(&self, __arg_0: &mut __HT)

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<T: Zeroable + CoerceUnsized<U>, U: Zeroable> CoerceUnsized<NonZero<U>> for NonZero<T>

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

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

Performs the conversion.

impl<'a, T: ?Sized> From<&'a mut T> for NonZero<*const T>

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

Performs the conversion.

impl<'a, T: ?Sized> From<&'a T> for NonZero<*const T>

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

Performs the conversion.