Struct primitive_types::U256

#[repr(C)]pub struct U256(pub [u64; 4]);

Little-endian large integer type 256-bit unsigned integer.

Implementations

impl U256

pub const MAX: U256

Maximum value.

pub fn from_dec_str(value: &str) -> Result<Self, FromDecStrErr>

Convert from a decimal string.

pub const fn low_u32(&self) -> u32

Conversion to u32

pub const fn low_u64(&self) -> u64

Low word (u64)

pub fn as_u32(&self) -> u32

Conversion to u32 with overflow checking

Panics

Panics if the number is larger than 2^32.

pub fn as_u64(&self) -> u64

Conversion to u64 with overflow checking

Panics

Panics if the number is larger than u64::max_value().

pub fn as_usize(&self) -> usize

Conversion to usize with overflow checking

Panics

Panics if the number is larger than usize::max_value().

pub fn is_zero(&self) -> bool

Whether this is zero.

pub fn bits(&self) -> usize

Return the least number of bits needed to represent the number

pub const fn bit(&self, index: usize) -> bool

Return if specific bit is set.

Panics

Panics if index exceeds the bit width of the number.

pub fn leading_zeros(&self) -> u32

Returns the number of leading zeros in the binary representation of self.

pub fn trailing_zeros(&self) -> u32

Returns the number of leading zeros in the binary representation of self.

pub const fn byte(&self, index: usize) -> u8

Return specific byte.

Panics

Panics if index exceeds the byte width of the number.

pub fn to_big_endian(&self, bytes: &mut [u8])

Write to the slice in big-endian format.

pub fn to_little_endian(&self, bytes: &mut [u8])

Write to the slice in little-endian format.

pub fn exp10(n: usize) -> Self

Create 10**n as this type.

Panics

Panics if the result overflows the type.

pub const fn zero() -> Self

Zero (additive identity) of this type.

pub fn one() -> Self

One (multiplicative identity) of this type.

pub fn max_value() -> Self

The maximum value which can be inhabited by this type.

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

Returns a pair (self / other, self % other).

Panics

Panics if other is zero.

pub fn pow(self, expon: Self) -> Self

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

Panics

Panics if the result overflows the type.

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

Fast exponentiation by squaring. Returns result and overflow flag.

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

Checked exponentiation. Returns None if overflow occurred.

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

Add with overflow.

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

Addition which saturates at the maximum value (Self::max_value()).

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

Checked addition. Returns None if overflow occurred.

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

Subtraction which underflows and returns a flag if it does.

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

Subtraction which saturates at zero.

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

Checked subtraction. Returns None if overflow occurred.

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

Multiply with overflow, returning a flag if it does.

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

Multiplication which saturates at the maximum value..

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

Checked multiplication. Returns None if overflow occurred.

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

Checked division. Returns None if other == 0.

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

Checked modulus. Returns None if other == 0.

pub fn overflowing_neg(self) -> (U256, bool)

Negation with overflow.

pub fn checked_neg(self) -> Option<U256>

Checked negation. Returns None unless self == 0.

pub fn from_big_endian(slice: &[u8]) -> Self

Converts from big endian representation bytes in memory.

pub fn from_little_endian(slice: &[u8]) -> Self

Converts from little endian representation bytes in memory.

impl U256

pub const fn low_u128(&self) -> u128

Low 2 words (u128)

pub fn as_u128(&self) -> u128

Conversion to u128 with overflow checking

Panics

Panics if the number is larger than 2^128.

impl U256

pub fn full_mul(self, other: U256) -> U512

Multiplies two 256-bit integers to produce full 512-bit integer No overflow possible

Trait Implementations

impl<T> Add<T> for U256 where
    T: Into<U256>, 

type Output = U256

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, T> Add<T> for &'a U256 where
    T: Into<U256>, 

type Output = U256

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<U256> for U256

fn add_assign(&mut self, other: U256)

Performs the += operation.

impl AsRef<[u64]> for U256

Get a reference to the underlying little-endian words.

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

Performs the conversion.

impl BitAnd<U256> for U256

type Output = U256

The resulting type after applying the & operator.

fn bitand(self, other: U256) -> U256

Performs the & operation.

impl BitOr<U256> for U256

type Output = U256

The resulting type after applying the | operator.

fn bitor(self, other: U256) -> U256

Performs the | operation.

impl BitXor<U256> for U256

type Output = U256

The resulting type after applying the ^ operator.

fn bitxor(self, other: U256) -> U256

Performs the ^ operation.

impl Clone for U256

fn clone(&self) -> U256

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for U256

impl Debug for U256

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

Formats the value using the given formatter.

impl Decode for U256

fn decode<I: Input>(input: &mut I) -> Result<Self, Error>

Attempt to deserialise the value from input.

impl Default for U256

fn default() -> Self

Returns the "default value" for a type.

impl Display for U256

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

Formats the value using the given formatter.

impl<T> Div<T> for U256 where
    T: Into<U256>, 

type Output = U256

The resulting type after applying the / operator.

fn div(self, other: T) -> U256

Performs the / operation.

impl<'a, T> Div<T> for &'a U256 where
    T: Into<U256>, 

type Output = U256

The resulting type after applying the / operator.

fn div(self, other: T) -> U256

Performs the / operation.

impl<T> DivAssign<T> for U256 where
    T: Into<U256>, 

fn div_assign(&mut self, other: T)

Performs the /= operation.

impl Encode for U256

fn using_encoded<R, F: FnOnce(&[u8]) -> R>(&self, f: F) -> R

Convert self to a slice and then invoke the given closure with it.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<T>(&self, dest: &mut T) where
    T: Output, 

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

impl EncodeLike<U256> for U256

impl Eq for U256

impl<'a> From<&'a [u8; 32]> for U256

fn from(bytes: &[u8; 32]) -> Self

Performs the conversion.

impl<'a> From<&'a [u8]> for U256

fn from(bytes: &[u8]) -> U256

Performs the conversion.

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

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

Performs the conversion.

impl<'a> From<&'a U256> for U512

fn from(value: &'a U256) -> U512

Performs the conversion.

impl From<&'static str> for U256

fn from(s: &'static str) -> Self

Performs the conversion.

impl From<[u8; 32]> for U256

fn from(bytes: [u8; 32]) -> Self

Performs the conversion.

impl From<U128> for U256

fn from(value: U128) -> U256

Performs the conversion.

impl From<U256> for [u8; 32]

fn from(number: U256) -> Self

Performs the conversion.

impl From<U256> for U512

fn from(value: U256) -> U512

Performs the conversion.

impl From<i128> for U256

fn from(value: i128) -> U256

Performs the conversion.

impl From<i16> for U256

fn from(value: i16) -> U256

Performs the conversion.

impl From<i32> for U256

fn from(value: i32) -> U256

Performs the conversion.

impl From<i64> for U256

fn from(value: i64) -> U256

Performs the conversion.

impl From<i8> for U256

fn from(value: i8) -> U256

Performs the conversion.

impl From<isize> for U256

fn from(value: isize) -> U256

Performs the conversion.

impl From<u128> for U256

fn from(value: u128) -> U256

Performs the conversion.

impl From<u16> for U256

fn from(value: u16) -> U256

Performs the conversion.

impl From<u32> for U256

fn from(value: u32) -> U256

Performs the conversion.

impl From<u64> for U256

fn from(value: u64) -> U256

Performs the conversion.

impl From<u8> for U256

fn from(value: u8) -> U256

Performs the conversion.

impl From<usize> for U256

fn from(value: usize) -> U256

Performs the conversion.

impl FromStr for U256

type Err = FromHexError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<U256, Self::Err>

Parses a string s to return a value of this type.

impl Hash for U256

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for U256

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

Formats the value using the given formatter.

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

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a i16> for U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a i16> for &'a U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a i32> for U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a i32> for &'a U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a i64> for U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a i64> for &'a U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a i8> for U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a i8> for &'a U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a isize> for U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a isize> for &'a U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a u16> for U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a u16> for &'a U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a u32> for U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a u32> for &'a U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a u64> for U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a u64> for &'a U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a u8> for U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a u8> for &'a U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a usize> for U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a usize> for &'a U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<U256> for U256

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = U256

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<i16> for U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: i16) -> U256

Performs the * operation.

impl<'a> Mul<i16> for &'a U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: i16) -> U256

Performs the * operation.

impl Mul<i32> for U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: i32) -> U256

Performs the * operation.

impl<'a> Mul<i32> for &'a U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: i32) -> U256

Performs the * operation.

impl Mul<i64> for U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: i64) -> U256

Performs the * operation.

impl<'a> Mul<i64> for &'a U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: i64) -> U256

Performs the * operation.

impl Mul<i8> for U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: i8) -> U256

Performs the * operation.

impl<'a> Mul<i8> for &'a U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: i8) -> U256

Performs the * operation.

impl Mul<isize> for U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: isize) -> U256

Performs the * operation.

impl<'a> Mul<isize> for &'a U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: isize) -> U256

Performs the * operation.

impl Mul<u16> for U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: u16) -> U256

Performs the * operation.

impl<'a> Mul<u16> for &'a U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: u16) -> U256

Performs the * operation.

impl Mul<u32> for U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: u32) -> U256

Performs the * operation.

impl<'a> Mul<u32> for &'a U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: u32) -> U256

Performs the * operation.

impl Mul<u64> for U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: u64) -> U256

Performs the * operation.

impl<'a> Mul<u64> for &'a U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: u64) -> U256

Performs the * operation.

impl Mul<u8> for U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: u8) -> U256

Performs the * operation.

impl<'a> Mul<u8> for &'a U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: u8) -> U256

Performs the * operation.

impl Mul<usize> for U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: usize) -> U256

Performs the * operation.

impl<'a> Mul<usize> for &'a U256

type Output = U256

The resulting type after applying the * operator.

fn mul(self, other: usize) -> U256

Performs the * operation.

impl MulAssign<U256> for U256

fn mul_assign(&mut self, other: U256)

Performs the *= operation.

impl MulAssign<i16> for U256

fn mul_assign(&mut self, other: i16)

Performs the *= operation.

impl MulAssign<i32> for U256

fn mul_assign(&mut self, other: i32)

Performs the *= operation.

impl MulAssign<i64> for U256

fn mul_assign(&mut self, other: i64)

Performs the *= operation.

impl MulAssign<i8> for U256

fn mul_assign(&mut self, other: i8)

Performs the *= operation.

impl MulAssign<isize> for U256

fn mul_assign(&mut self, other: isize)

Performs the *= operation.

impl MulAssign<u16> for U256

fn mul_assign(&mut self, other: u16)

Performs the *= operation.

impl MulAssign<u32> for U256

fn mul_assign(&mut self, other: u32)

Performs the *= operation.

impl MulAssign<u64> for U256

fn mul_assign(&mut self, other: u64)

Performs the *= operation.

impl MulAssign<u8> for U256

fn mul_assign(&mut self, other: u8)

Performs the *= operation.

impl MulAssign<usize> for U256

fn mul_assign(&mut self, other: usize)

Performs the *= operation.

impl Not for U256

type Output = U256

The resulting type after applying the ! operator.

fn not(self) -> U256

Performs the unary ! operation.

impl Ord for U256

fn cmp(&self, other: &U256) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<U256> for U256

fn eq(&self, other: &U256) -> bool

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

fn ne(&self, other: &U256) -> bool

This method tests for !=.

impl PartialOrd<U256> for U256

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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> Rem<T> for U256 where
    T: Into<U256> + Copy, 

type Output = U256

The resulting type after applying the % operator.

fn rem(self, other: T) -> U256

Performs the % operation.

impl<'a, T> Rem<T> for &'a U256 where
    T: Into<U256> + Copy, 

type Output = U256

The resulting type after applying the % operator.

fn rem(self, other: T) -> U256

Performs the % operation.

impl<T> RemAssign<T> for U256 where
    T: Into<U256> + Copy, 

fn rem_assign(&mut self, other: T)

Performs the %= operation.

impl<T> Shl<T> for U256 where
    T: Into<U256>, 

type Output = U256

The resulting type after applying the << operator.

fn shl(self, shift: T) -> U256

Performs the << operation.

impl<'a, T> Shl<T> for &'a U256 where
    T: Into<U256>, 

type Output = U256

The resulting type after applying the << operator.

fn shl(self, shift: T) -> U256

Performs the << operation.

impl<T> ShlAssign<T> for U256 where
    T: Into<U256>, 

fn shl_assign(&mut self, shift: T)

Performs the <<= operation.

impl<T> Shr<T> for U256 where
    T: Into<U256>, 

type Output = U256

The resulting type after applying the >> operator.

fn shr(self, shift: T) -> U256

Performs the >> operation.

impl<'a, T> Shr<T> for &'a U256 where
    T: Into<U256>, 

type Output = U256

The resulting type after applying the >> operator.

fn shr(self, shift: T) -> U256

Performs the >> operation.

impl<T> ShrAssign<T> for U256 where
    T: Into<U256>, 

fn shr_assign(&mut self, shift: T)

Performs the >>= operation.

impl StructuralEq for U256

impl StructuralPartialEq for U256

impl<T> Sub<T> for U256 where
    T: Into<U256>, 

type Output = U256

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, T> Sub<T> for &'a U256 where
    T: Into<U256>, 

type Output = U256

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<U256> for U256

fn sub_assign(&mut self, other: U256)

Performs the -= operation.

impl<'a> TryFrom<&'a U512> for U256

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a U512) -> Result<U256, Error>

Performs the conversion.

impl TryFrom<U256> for u8

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(u: U256) -> Result<u8, &'static str>

Performs the conversion.

impl TryFrom<U256> for u16

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(u: U256) -> Result<u16, &'static str>

Performs the conversion.

impl TryFrom<U256> for u128

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(u: U256) -> Result<u128, &'static str>

Performs the conversion.

impl TryFrom<U256> for i128

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(u: U256) -> Result<i128, &'static str>

Performs the conversion.

impl TryFrom<U256> for U128

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: U256) -> Result<U128, Error>

Performs the conversion.

impl TryFrom<U256> for u32

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(u: U256) -> Result<u32, &'static str>

Performs the conversion.

impl TryFrom<U256> for usize

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(u: U256) -> Result<usize, &'static str>

Performs the conversion.

impl TryFrom<U256> for u64

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(u: U256) -> Result<u64, &'static str>

Performs the conversion.

impl TryFrom<U256> for i8

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(u: U256) -> Result<i8, &'static str>

Performs the conversion.

impl TryFrom<U256> for i16

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(u: U256) -> Result<i16, &'static str>

Performs the conversion.

impl TryFrom<U256> for i32

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(u: U256) -> Result<i32, &'static str>

Performs the conversion.

impl TryFrom<U256> for isize

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(u: U256) -> Result<isize, &'static str>

Performs the conversion.

impl TryFrom<U256> for i64

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(u: U256) -> Result<i64, &'static str>

Performs the conversion.

impl TryFrom<U512> for U256

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: U512) -> Result<U256, Error>

Performs the conversion.