Struct NonZero

pub struct NonZero<T> { /* private fields */ }

An integer that is known to not equal zero.

Implementations

impl<T> NonZero<T>

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

Returns a new NonZero without checking that the provided value is nonzero.

Safety

value must be known to be nonzero

pub const fn get(&self) -> &T

A reference to the nonzero value

pub const unsafe fn get_mut(&mut self) -> &mut T

A mutable reference to the nonzero value

Safety

The caller must guarantee that the value is nonzero when the mutable reference is dropped

impl<T> NonZero<T>

where T: Zero,

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

Returns a new NonZero<T> if value is nonzero

impl<T> NonZero<T>

where T: Integer,

pub fn is_even(self) -> bool

Whether the nonzero integer is even

pub fn is_odd(self) -> bool

Whether the nonzero integer is odd

pub fn set(&mut self, value: T) -> bool

Sets self.value using the provided value. Only succeeds if the value provided was nonzero. Returns whether the operation succeeded.

pub unsafe fn set_unchecked(&mut self, value: T)

Sets the internal value of the nonzero integer. If the value equals zero, this panics.

Safety

value must be known to be nonzero

pub fn map(self, f: impl Fn(T) -> T) -> Option<Self>

Applies a function to the inner value and returns a NonZero if the result was nonzero.

pub unsafe fn map_unchecked(self, f: impl Fn(T) -> T) -> Self

Applies a function to the inner value and returns a NonZero if the result was nonzero.

Safety

f must return a nonzero integer

impl<T> NonZero<T>

where T: PrimInt + Shr<u32, Output = T>,

pub fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of the nonzero integer

pub fn without_trailing_zeros(self) -> Self

Returns the number of trailing zeros in the binary representation of the nonzero integer

Trait Implementations

impl<T: Clone> 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: Debug> Debug for NonZero<T>

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

Formats the value using the given formatter.

impl<T> Display for NonZero<T>

where T: Display,

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

Formats the value using the given formatter.

impl From<NonZero<u128>> for NonZero<u128>

fn from(value: NonZeroU128) -> Self

Converts to this type from the input type.

impl From<NonZero<u16>> for NonZero<u16>

fn from(value: NonZeroU16) -> Self

Converts to this type from the input type.

impl From<NonZero<u32>> for NonZero<u32>

fn from(value: NonZeroU32) -> Self

Converts to this type from the input type.

impl From<NonZero<u64>> for NonZero<u64>

fn from(value: NonZeroU64) -> Self

Converts to this type from the input type.

impl From<NonZero<u8>> for NonZero<u8>

fn from(value: NonZeroU8) -> Self

Converts to this type from the input type.

impl From<NonZero<usize>> for NonZero<usize>

fn from(value: NonZeroUsize) -> Self

Converts to this type from the input type.

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

fn cmp(&self, other: &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.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

fn eq(&self, other: &NonZero<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: PartialOrd> PartialOrd for NonZero<T>

fn partial_cmp(&self, other: &NonZero<T>) -> 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: Copy> Copy for NonZero<T>

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

impl<T> StructuralPartialEq for NonZero<T>