Struct NonZero

pub struct NonZero<T: Zero>(/* private fields */);

Wrapper type for non-zero integers.

Implementations

impl NonZero<Limb>

pub const fn const_new(n: Limb) -> (Self, CtChoice)

Creates a new non-zero limb in a const context. The second return value is FALSE if n is zero, TRUE otherwise.

impl<const LIMBS: usize> NonZero<Uint<LIMBS>>

pub const fn const_new(n: Uint<LIMBS>) -> (Self, CtChoice)

Creates a new non-zero integer in a const context. The second return value is FALSE if n is zero, TRUE otherwise.

impl<T> NonZero<T>

where T: Zero,

pub fn new(n: T) -> CtOption<Self>

Create a new non-zero integer.

impl<T> NonZero<T>

where T: Integer,

pub const ONE: Self = _

The value 1.

pub const MAX: Self = _

Maximum value this integer can express.

impl<T> NonZero<T>

where T: Encoding + Zero,

pub fn from_be_bytes(bytes: T::Repr) -> CtOption<Self>

Decode from big endian bytes.

pub fn from_le_bytes(bytes: T::Repr) -> CtOption<Self>

Decode from little endian bytes.

impl<T> NonZero<T>

where T: ArrayEncoding + Zero,

pub fn from_be_byte_array(bytes: ByteArray<T>) -> CtOption<Self>

Decode a non-zero integer from big endian bytes.

pub fn from_le_byte_array(bytes: ByteArray<T>) -> CtOption<Self>

Decode a non-zero integer from big endian bytes.

impl NonZero<Limb>

pub const fn from_u8(n: NonZeroU8) -> Self

Create a NonZero<Limb> from a NonZeroU8 (const-friendly)

pub const fn from_u16(n: NonZeroU16) -> Self

Create a NonZero<Limb> from a NonZeroU16 (const-friendly)

pub const fn from_u32(n: NonZeroU32) -> Self

Create a NonZero<Limb> from a NonZeroU32 (const-friendly)

pub const fn from_u64(n: NonZeroU64) -> Self

Create a NonZero<Limb> from a NonZeroU64 (const-friendly)

impl<const LIMBS: usize> NonZero<Uint<LIMBS>>

pub const fn from_uint(n: Uint<LIMBS>) -> Self

Create a NonZero<Uint> from a Uint (const-friendly)

pub const fn from_u8(n: NonZeroU8) -> Self

Create a NonZero<Uint> from a NonZeroU8 (const-friendly)

pub const fn from_u16(n: NonZeroU16) -> Self

Create a NonZero<Uint> from a NonZeroU16 (const-friendly)

pub const fn from_u32(n: NonZeroU32) -> Self

Create a NonZero<Uint> from a NonZeroU32 (const-friendly)

pub const fn from_u64(n: NonZeroU64) -> Self

Create a NonZero<Uint> from a NonZeroU64 (const-friendly)

pub const fn from_u128(n: NonZeroU128) -> Self

Create a NonZero<Uint> from a NonZeroU128 (const-friendly)

Trait Implementations

impl<T> AsRef<T> for NonZero<T>

where T: Zero,

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Binary for NonZero<T>

where T: Binary + Zero,

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

Formats the value using the given formatter.

impl<T: Clone + Zero> 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> ConditionallySelectable for NonZero<T>

where T: ConditionallySelectable + Zero,

fn conditional_select(a: &Self, b: &Self, choice: Choice) -> Self

Select a or b according to choice.

fn conditional_assign(&mut self, other: &Self, choice: Choice)

Conditionally assign other to self, according to choice.

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves.

impl<T> ConstantTimeEq for NonZero<T>

where T: Zero,

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

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

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

Formats the value using the given formatter.

impl<T: Default + Zero> Default for NonZero<T>

fn default() -> NonZero<T>

Returns the “default value” for a type.

impl<T> Deref for NonZero<T>

where T: Zero,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> Display for NonZero<T>

where T: Display + Zero,

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

Formats the value using the given formatter.

impl<const LIMBS: usize> Div<&NonZero<Limb>> for &Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: &NonZero<Limb>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<&NonZero<Limb>> for &Wrapping<Uint<LIMBS>>

type Output = Wrapping<Uint<LIMBS>>

The resulting type after applying the / operator.

fn div(self, rhs: &NonZero<Limb>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<&NonZero<Limb>> for Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: &NonZero<Limb>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<&NonZero<Limb>> for Wrapping<Uint<LIMBS>>

type Output = Wrapping<Uint<LIMBS>>

The resulting type after applying the / operator.

fn div(self, rhs: &NonZero<Limb>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<&NonZero<Uint<LIMBS>>> for &Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: &NonZero<Uint<LIMBS>>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<&NonZero<Uint<LIMBS>>> for &Wrapping<Uint<LIMBS>>

type Output = Wrapping<Uint<LIMBS>>

The resulting type after applying the / operator.

fn div(self, rhs: &NonZero<Uint<LIMBS>>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<&NonZero<Uint<LIMBS>>> for Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: &NonZero<Uint<LIMBS>>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<&NonZero<Uint<LIMBS>>> for Wrapping<Uint<LIMBS>>

type Output = Wrapping<Uint<LIMBS>>

The resulting type after applying the / operator.

fn div(self, rhs: &NonZero<Uint<LIMBS>>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<NonZero<Limb>> for &Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: NonZero<Limb>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<NonZero<Limb>> for &Wrapping<Uint<LIMBS>>

type Output = Wrapping<Uint<LIMBS>>

The resulting type after applying the / operator.

fn div(self, rhs: NonZero<Limb>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<NonZero<Limb>> for Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: NonZero<Limb>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<NonZero<Limb>> for Wrapping<Uint<LIMBS>>

type Output = Wrapping<Uint<LIMBS>>

The resulting type after applying the / operator.

fn div(self, rhs: NonZero<Limb>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<NonZero<Uint<LIMBS>>> for &Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: NonZero<Uint<LIMBS>>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<NonZero<Uint<LIMBS>>> for &Wrapping<Uint<LIMBS>>

type Output = Wrapping<Uint<LIMBS>>

The resulting type after applying the / operator.

fn div(self, rhs: NonZero<Uint<LIMBS>>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<NonZero<Uint<LIMBS>>> for Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the / operator.

fn div(self, rhs: NonZero<Uint<LIMBS>>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> Div<NonZero<Uint<LIMBS>>> for Wrapping<Uint<LIMBS>>

type Output = Wrapping<Uint<LIMBS>>

The resulting type after applying the / operator.

fn div(self, rhs: NonZero<Uint<LIMBS>>) -> Self::Output

Performs the / operation.

impl<const LIMBS: usize> DivAssign<&NonZero<Limb>> for Uint<LIMBS>

fn div_assign(&mut self, rhs: &NonZero<Limb>)

Performs the /= operation.

impl<const LIMBS: usize> DivAssign<&NonZero<Limb>> for Wrapping<Uint<LIMBS>>

fn div_assign(&mut self, rhs: &NonZero<Limb>)

Performs the /= operation.

impl<const LIMBS: usize> DivAssign<&NonZero<Uint<LIMBS>>> for Uint<LIMBS>

fn div_assign(&mut self, rhs: &NonZero<Uint<LIMBS>>)

Performs the /= operation.

impl<const LIMBS: usize> DivAssign<&NonZero<Uint<LIMBS>>> for Wrapping<Uint<LIMBS>>

fn div_assign(&mut self, rhs: &NonZero<Uint<LIMBS>>)

Performs the /= operation.

impl<const LIMBS: usize> DivAssign<NonZero<Limb>> for Uint<LIMBS>

fn div_assign(&mut self, rhs: NonZero<Limb>)

Performs the /= operation.

impl<const LIMBS: usize> DivAssign<NonZero<Limb>> for Wrapping<Uint<LIMBS>>

fn div_assign(&mut self, rhs: NonZero<Limb>)

Performs the /= operation.

impl<const LIMBS: usize> DivAssign<NonZero<Uint<LIMBS>>> for Uint<LIMBS>

fn div_assign(&mut self, rhs: NonZero<Uint<LIMBS>>)

Performs the /= operation.

impl<const LIMBS: usize> DivAssign<NonZero<Uint<LIMBS>>> for Wrapping<Uint<LIMBS>>

fn div_assign(&mut self, rhs: NonZero<Uint<LIMBS>>)

Performs the /= operation.

impl<const LIMBS: usize> From<NonZero<u128>> for NonZero<Uint<LIMBS>>

fn from(integer: NonZeroU128) -> Self

Converts to this type from the input type.

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

fn from(integer: NonZeroU16) -> Self

Converts to this type from the input type.

impl<const LIMBS: usize> From<NonZero<u16>> for NonZero<Uint<LIMBS>>

fn from(integer: NonZeroU16) -> Self

Converts to this type from the input type.

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

fn from(integer: NonZeroU32) -> Self

Converts to this type from the input type.

impl<const LIMBS: usize> From<NonZero<u32>> for NonZero<Uint<LIMBS>>

fn from(integer: NonZeroU32) -> Self

Converts to this type from the input type.

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

fn from(integer: NonZeroU64) -> Self

Converts to this type from the input type.

impl<const LIMBS: usize> From<NonZero<u64>> for NonZero<Uint<LIMBS>>

fn from(integer: NonZeroU64) -> Self

Converts to this type from the input type.

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

fn from(integer: NonZeroU8) -> Self

Converts to this type from the input type.

impl<const LIMBS: usize> From<NonZero<u8>> for NonZero<Uint<LIMBS>>

fn from(integer: NonZeroU8) -> Self

Converts to this type from the input type.

impl<MOD: ResidueParams<LIMBS>, const LIMBS: usize> Invert for NonZero<Residue<MOD, LIMBS>>

type Output = NonZero<Residue<MOD, LIMBS>>

Output of the inversion.

fn invert(&self) -> Self::Output

Computes the inverse.

impl<T> LowerHex for NonZero<T>

where T: LowerHex + Zero,

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

Formats the value using the given formatter.

impl<T> Octal for NonZero<T>

where T: Octal + Zero,

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

Formats the value using the given formatter.

impl<T: Ord + Zero> 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 + Zero> 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 + Zero> 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> Random for NonZero<T>

where T: Random + Zero,

fn random(rng: &mut impl CryptoRngCore) -> Self

Generate a random NonZero<T>.

impl<const LIMBS: usize> Rem<&NonZero<Limb>> for &Uint<LIMBS>

type Output = Limb

The resulting type after applying the % operator.

fn rem(self, rhs: &NonZero<Limb>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<&NonZero<Limb>> for &Wrapping<Uint<LIMBS>>

type Output = Wrapping<Limb>

The resulting type after applying the % operator.

fn rem(self, rhs: &NonZero<Limb>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<&NonZero<Limb>> for Uint<LIMBS>

type Output = Limb

The resulting type after applying the % operator.

fn rem(self, rhs: &NonZero<Limb>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<&NonZero<Limb>> for Wrapping<Uint<LIMBS>>

type Output = Wrapping<Limb>

The resulting type after applying the % operator.

fn rem(self, rhs: &NonZero<Limb>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<&NonZero<Uint<LIMBS>>> for &Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the % operator.

fn rem(self, rhs: &NonZero<Uint<LIMBS>>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<&NonZero<Uint<LIMBS>>> for &Wrapping<Uint<LIMBS>>

type Output = Wrapping<Uint<LIMBS>>

The resulting type after applying the % operator.

fn rem(self, rhs: &NonZero<Uint<LIMBS>>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<&NonZero<Uint<LIMBS>>> for Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the % operator.

fn rem(self, rhs: &NonZero<Uint<LIMBS>>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<&NonZero<Uint<LIMBS>>> for Wrapping<Uint<LIMBS>>

type Output = Wrapping<Uint<LIMBS>>

The resulting type after applying the % operator.

fn rem(self, rhs: &NonZero<Uint<LIMBS>>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<NonZero<Limb>> for &Uint<LIMBS>

type Output = Limb

The resulting type after applying the % operator.

fn rem(self, rhs: NonZero<Limb>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<NonZero<Limb>> for &Wrapping<Uint<LIMBS>>

type Output = Wrapping<Limb>

The resulting type after applying the % operator.

fn rem(self, rhs: NonZero<Limb>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<NonZero<Limb>> for Uint<LIMBS>

type Output = Limb

The resulting type after applying the % operator.

fn rem(self, rhs: NonZero<Limb>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<NonZero<Limb>> for Wrapping<Uint<LIMBS>>

type Output = Wrapping<Limb>

The resulting type after applying the % operator.

fn rem(self, rhs: NonZero<Limb>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<NonZero<Uint<LIMBS>>> for &Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the % operator.

fn rem(self, rhs: NonZero<Uint<LIMBS>>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<NonZero<Uint<LIMBS>>> for &Wrapping<Uint<LIMBS>>

type Output = Wrapping<Uint<LIMBS>>

The resulting type after applying the % operator.

fn rem(self, rhs: NonZero<Uint<LIMBS>>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<NonZero<Uint<LIMBS>>> for Uint<LIMBS>

type Output = Uint<LIMBS>

The resulting type after applying the % operator.

fn rem(self, rhs: NonZero<Uint<LIMBS>>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> Rem<NonZero<Uint<LIMBS>>> for Wrapping<Uint<LIMBS>>

type Output = Wrapping<Uint<LIMBS>>

The resulting type after applying the % operator.

fn rem(self, rhs: NonZero<Uint<LIMBS>>) -> Self::Output

Performs the % operation.

impl<const LIMBS: usize> RemAssign<&NonZero<Limb>> for Uint<LIMBS>

fn rem_assign(&mut self, rhs: &NonZero<Limb>)

Performs the %= operation.

impl<const LIMBS: usize> RemAssign<&NonZero<Limb>> for Wrapping<Uint<LIMBS>>

fn rem_assign(&mut self, rhs: &NonZero<Limb>)

Performs the %= operation.

impl<const LIMBS: usize> RemAssign<&NonZero<Uint<LIMBS>>> for Uint<LIMBS>

fn rem_assign(&mut self, rhs: &NonZero<Uint<LIMBS>>)

Performs the %= operation.

impl<const LIMBS: usize> RemAssign<&NonZero<Uint<LIMBS>>> for Wrapping<Uint<LIMBS>>

fn rem_assign(&mut self, rhs: &NonZero<Uint<LIMBS>>)

Performs the %= operation.

impl<const LIMBS: usize> RemAssign<NonZero<Limb>> for Uint<LIMBS>

fn rem_assign(&mut self, rhs: NonZero<Limb>)

Performs the %= operation.

impl<const LIMBS: usize> RemAssign<NonZero<Limb>> for Wrapping<Uint<LIMBS>>

fn rem_assign(&mut self, rhs: NonZero<Limb>)

Performs the %= operation.

impl<const LIMBS: usize> RemAssign<NonZero<Uint<LIMBS>>> for Uint<LIMBS>

fn rem_assign(&mut self, rhs: NonZero<Uint<LIMBS>>)

Performs the %= operation.

impl<const LIMBS: usize> RemAssign<NonZero<Uint<LIMBS>>> for Wrapping<Uint<LIMBS>>

fn rem_assign(&mut self, rhs: NonZero<Uint<LIMBS>>)

Performs the %= operation.

impl<T> UpperHex for NonZero<T>

where T: UpperHex + Zero,

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

Formats the value using the given formatter.

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

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

impl<T: Zero> StructuralPartialEq for NonZero<T>