Struct gprimitives::NonZeroU256

pub struct NonZeroU256(/* private fields */);

A value that is known not to equal zero.

Implementations

impl NonZeroU256

pub const MIN: NonZeroU256 = _

The smallest value that can be represented by this non-zero

pub const MAX: NonZeroU256 = _

The largest value that can be represented by this non-zero

pub const fn new(n: U256) -> Option<Self>

Creates a non-zero if the given value is not zero.

pub const unsafe fn new_unchecked(n: U256) -> Self

Creates a non-zero without checking whether the value is non-zero. This results in undefined behaviour if the value is zero.

Safety

The value must not be zero.

pub const fn get(self) -> U256

Returns the contained value as a primitive type.

pub fn checked_add(self, other: U256) -> Option<Self>

Adds an unsigned integer to a non-zero value. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

pub fn saturating_add(self, other: U256) -> Self

Adds an unsigned integer to a non-zero value.

pub fn overflowing_add(self, other: U256) -> (Self, bool)

Addition which overflows and returns a flag if it does.

pub fn checked_sub(self, other: U256) -> Option<Self>

Checked subtraction. Returns None if overflow occurred.

pub fn saturating_sub(self, other: U256) -> Self

Subtraction which saturates at MIN.

pub fn overflowing_sub(self, other: U256) -> (Self, bool)

Subtraction which underflows and returns a flag if it does.

pub fn checked_mul(self, other: Self) -> Option<Self>

Multiplies two non-zero integers together. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

pub fn saturating_mul(self, other: Self) -> Self

Multiplies two non-zero integers together.

pub fn overflowing_mul(self, other: Self) -> (Self, bool)

Multiply with overflow, returning a flag if it does.

pub fn checked_pow(self, other: U256) -> Option<Self>

Raises non-zero value to an integer power. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to zero.

pub fn overflowing_pow(self, other: U256) -> (Self, bool)

Raise non-zero value to an integer power.

pub fn pow(self, other: U256) -> Self

Fast exponentiation by squaring https://en.wikipedia.org/wiki/Exponentiation_by_squaring

Panics

Panics if the result overflows the type.

Trait Implementations

impl<'a, T> Add<T> for &'a NonZeroU256

where T: Into<U256>,

type Output = NonZeroU256

The resulting type after applying the + operator.

fn add(self, other: T) -> NonZeroU256

Performs the + operation.

impl<T> Add<T> for NonZeroU256

where T: Into<U256>,

type Output = NonZeroU256

The resulting type after applying the + operator.

fn add(self, other: T) -> NonZeroU256

Performs the + operation.

impl<T> AddAssign<T> for NonZeroU256

where T: Into<U256>,

fn add_assign(&mut self, other: T)

Performs the += operation.

impl AsRef<[u64]> for NonZeroU256

Get a reference to the underlying little-endian words.

fn as_ref(&self) -> &[u64]

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

impl Clone for NonZeroU256

fn clone(&self) -> NonZeroU256

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NonZeroU256

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

Formats the value using the given formatter.

impl Display for NonZeroU256

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

Formats the value using the given formatter.

impl<'a> From<&'a NonZeroU256> for NonZeroU256

fn from(x: &'a NonZeroU256) -> NonZeroU256

Converts to this type from the input type.

impl From<NonZero<u128>> for NonZeroU256

fn from(value: NonZeroU128) -> Self

Converts to this type from the input type.

impl From<NonZero<u16>> for NonZeroU256

fn from(value: NonZeroU16) -> Self

Converts to this type from the input type.

impl From<NonZero<u32>> for NonZeroU256

fn from(value: NonZeroU32) -> Self

Converts to this type from the input type.

impl From<NonZero<u64>> for NonZeroU256

fn from(value: NonZeroU64) -> Self

Converts to this type from the input type.

impl From<NonZero<u8>> for NonZeroU256

fn from(value: NonZeroU8) -> Self

Converts to this type from the input type.

impl From<NonZeroU256> for U256

fn from(nonzero: NonZeroU256) -> Self

Converts to this type from the input type.

impl Hash for NonZeroU256

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for NonZeroU256

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

Formats the value using the given formatter.

impl<'a> Mul<&'a NonZeroU256> for NonZeroU256

type Output = NonZeroU256

The resulting type after applying the * operator.

fn mul(self, other: &'a NonZeroU256) -> NonZeroU256

Performs the * operation.

impl<'a> Mul<NonZeroU256> for &'a NonZeroU256

type Output = NonZeroU256

The resulting type after applying the * operator.

fn mul(self, other: NonZeroU256) -> NonZeroU256

Performs the * operation.

impl<'a> Mul for &'a NonZeroU256

type Output = NonZeroU256

The resulting type after applying the * operator.

fn mul(self, other: &'a NonZeroU256) -> NonZeroU256

Performs the * operation.

impl Mul for NonZeroU256

type Output = NonZeroU256

The resulting type after applying the * operator.

fn mul(self, other: NonZeroU256) -> NonZeroU256

Performs the * operation.

impl MulAssign for NonZeroU256

fn mul_assign(&mut self, other: NonZeroU256)

Performs the *= operation.

impl Ord for NonZeroU256

fn cmp(&self, other: &Self) -> 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 PartialEq for NonZeroU256

fn eq(&self, other: &Self) -> 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 PartialOrd for NonZeroU256

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

fn lt(&self, other: &Self) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, T> Sub<T> for &'a NonZeroU256

where T: Into<U256>,

type Output = NonZeroU256

The resulting type after applying the - operator.

fn sub(self, other: T) -> NonZeroU256

Performs the - operation.

impl<T> Sub<T> for NonZeroU256

where T: Into<U256>,

type Output = NonZeroU256

The resulting type after applying the - operator.

fn sub(self, other: T) -> NonZeroU256

Performs the - operation.

impl<T> SubAssign<T> for NonZeroU256

where T: Into<U256>,

fn sub_assign(&mut self, other: T)

Performs the -= operation.

impl TryFrom<u128> for NonZeroU256

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: u128) -> Result<NonZeroU256, &'static str>

Performs the conversion.

impl TryFrom<u16> for NonZeroU256

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<NonZeroU256, &'static str>

Performs the conversion.

impl TryFrom<u32> for NonZeroU256

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<NonZeroU256, &'static str>

Performs the conversion.

impl TryFrom<u64> for NonZeroU256

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<NonZeroU256, &'static str>

Performs the conversion.

impl TryFrom<u8> for NonZeroU256

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<NonZeroU256, &'static str>

Performs the conversion.

impl UpperHex for NonZeroU256

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

Formats the value using the given formatter.

impl Copy for NonZeroU256

impl Eq for NonZeroU256