Struct crypto_bigint::NonZero

pub struct NonZero<T: Integer>(_);

Wrapper type for non-zero integers.

Implementations

impl<T> NonZero<T> where
    T: Integer, 

pub const ONE: Self

The value 1.

pub const MAX: Self

Maximum value this integer can express.

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

Create a new non-zero integer.

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

Decode from big endian bytes.

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

Decode from little endian bytes.

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

This is supported on crate feature generic-array only.

Decode a non-zero integer from big endian bytes.

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

This is supported on crate feature generic-array only.

Decode a non-zero integer from big endian bytes.

impl<const LIMBS: usize> NonZero<UInt<LIMBS>> where
    UInt<LIMBS>: Integer, 

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: Integer, 

fn as_ref(&self) -> &T

Performs the conversion.

impl<T> Binary for NonZero<T> where
    T: Integer + Binary, 

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

Formats the value using the given formatter.

impl<T: Clone + Integer> 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: Integer, 

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: Integer, 

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

Determine if two items are equal.

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

fn default() -> NonZero<T>

Returns the “default value” for a type.

impl<T> Deref for NonZero<T> where
    T: Integer, 

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> Display for NonZero<T> where
    T: Integer + Display, 

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

Formats the value using the given formatter.

impl<const LIMBS: usize> Div<&'_ NonZero<UInt<LIMBS>>> for &UInt<LIMBS> where
    UInt<LIMBS>: Integer, 

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 UInt<LIMBS> where
    UInt<LIMBS>: Integer, 

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 &UInt<LIMBS> where
    UInt<LIMBS>: Integer, 

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 UInt<LIMBS> where
    UInt<LIMBS>: Integer, 

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> DivAssign<&'_ NonZero<UInt<LIMBS>>> for UInt<LIMBS> where
    UInt<LIMBS>: Integer, 

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

Performs the /= operation.

impl<const LIMBS: usize> DivAssign<NonZero<UInt<LIMBS>>> for UInt<LIMBS> where
    UInt<LIMBS>: Integer, 

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

Performs the /= operation.

impl<const LIMBS: usize> From<NonZeroU128> for NonZero<UInt<LIMBS>> where
    UInt<LIMBS>: Integer, 

fn from(integer: NonZeroU128) -> Self

Performs the conversion.

impl<const LIMBS: usize> From<NonZeroU16> for NonZero<UInt<LIMBS>> where
    UInt<LIMBS>: Integer, 

fn from(integer: NonZeroU16) -> Self

Performs the conversion.

impl<const LIMBS: usize> From<NonZeroU32> for NonZero<UInt<LIMBS>> where
    UInt<LIMBS>: Integer, 

fn from(integer: NonZeroU32) -> Self

Performs the conversion.

impl<const LIMBS: usize> From<NonZeroU64> for NonZero<UInt<LIMBS>> where
    UInt<LIMBS>: Integer, 

fn from(integer: NonZeroU64) -> Self

Performs the conversion.

impl<const LIMBS: usize> From<NonZeroU8> for NonZero<UInt<LIMBS>> where
    UInt<LIMBS>: Integer, 

fn from(integer: NonZeroU8) -> Self

Performs the conversion.

impl<T> LowerHex for NonZero<T> where
    T: Integer + LowerHex, 

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

Formats the value using the given formatter.

impl<T> Octal for NonZero<T> where
    T: Integer + Octal, 

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

Formats the value using the given formatter.

impl<T: Ord + Integer> 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

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

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

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

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

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

This method tests for !=.

impl<T: PartialOrd + Integer> PartialOrd<NonZero<T>> 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

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

fn ge(&self, other: &Rhs) -> bool

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

impl<T> Random for NonZero<T> where
    T: Integer + Random, 

This is supported on crate feature rand only.

fn random(rng: impl CryptoRng + RngCore) -> Self

Generate a random NonZero<T>.

impl<const LIMBS: usize> Rem<&'_ NonZero<UInt<LIMBS>>> for &UInt<LIMBS> where
    UInt<LIMBS>: Integer, 

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 UInt<LIMBS> where
    UInt<LIMBS>: Integer, 

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 &UInt<LIMBS> where
    UInt<LIMBS>: Integer, 

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 UInt<LIMBS> where
    UInt<LIMBS>: Integer, 

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> RemAssign<&'_ NonZero<UInt<LIMBS>>> for UInt<LIMBS> where
    UInt<LIMBS>: Integer, 

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

Performs the %= operation.

impl<const LIMBS: usize> RemAssign<NonZero<UInt<LIMBS>>> for UInt<LIMBS> where
    UInt<LIMBS>: Integer, 

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

Performs the %= operation.

impl<T> UpperHex for NonZero<T> where
    T: Integer + UpperHex, 

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

Formats the value using the given formatter.

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

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

impl<T: Integer> StructuralEq for NonZero<T>

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