Struct amplify_num::u256

pub struct u256(_);

Large integer type

The type is composed of little-endian ordered 64-bit words, which represents its inner representation.

Implementations

impl u256

pub fn as_ptr(&self) -> *const u64

Converts the object to a raw pointer

pub fn as_mut_ptr(&mut self) -> *mut u64

Converts the object to a mutable raw pointer

pub fn as_inner(&self) -> &[u64; 4]

Returns the underlying array of words constituting large integer

pub fn into_inner(self) -> [u64; 4]

Returns the underlying array of words constituting large integer

pub fn from_inner(array: [u64; 4]) -> Self

Constructs integer type from the underlying array of words.

impl u256

pub const ZERO: u256

Zero value

pub const ONE: u256

Value for 1

pub const MIN: u256

Minimum value

pub const MAX: u256

Maximum value

pub const BITS: u32

Bit dimension

pub const BYTES: u8

Length of the integer in bytes

pub const INNER_LEN: u8

Length of the inner representation in 64-bit words

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

Returns whether specific bit number is set to 1 or not

pub fn low_u32(&self) -> u32

Returns lower 32 bits of the number as u32

pub fn low_u64(&self) -> u64

Returns lower 64 bits of the number as u32

pub fn bits_required(&self) -> usize

Return the least number of bits needed to represent the number

pub fn from_be_bytes(bytes: [u8; 32]) -> u256

Creates the integer value from a byte array using big-endian encoding

pub fn from_be_slice(bytes: &[u8]) -> Result<u256, ParseLengthError>

Creates the integer value from a byte slice using big-endian encoding

pub fn from_le_bytes(bytes: [u8; 32]) -> u256

Creates the integer value from a byte array using little-endian encoding

pub fn from_le_slice(bytes: &[u8]) -> Result<u256, ParseLengthError>

Creates the integer value from a byte slice using little-endian encoding

pub fn to_be_bytes(self) -> [u8; 32]

Convert the integer into a byte array using big-endian encoding

pub fn to_le_bytes(self) -> [u8; 32]

Convert a integer into a byte array using little-endian encoding

impl u256

pub fn checked_add<T>(self, other: T) -> Option<u256> where
    T: Into<u256>, 

Checked integer addition. Computes self + rhs, returning None if overflow occurred.

pub fn saturating_add<T>(self, other: T) -> u256 where
    T: Into<u256>, 

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

pub fn overflowing_add<T>(self, other: T) -> (u256, bool) where
    T: Into<u256>, 

Calculates self + rhs

Returns a tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

pub fn wrapping_add<T>(self, other: T) -> u256 where
    T: Into<u256>, 

Wrapping (modular) addition. Computes self + rhs, wrapping around at the boundary of the type.

pub fn checked_sub<T>(self, other: T) -> Option<u256> where
    T: Into<u256>, 

Checked integer subtraction. Computes self - rhs, returning None if overflow occurred.

pub fn saturating_sub<T>(self, other: T) -> u256 where
    T: Into<u256>, 

Saturating integer subtraction. Computes self - rhs, saturating at the numeric bounds instead of overflowing.

pub fn overflowing_sub<T>(self, other: T) -> (u256, bool) where
    T: Into<u256>, 

Calculates self - rhs

Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

pub fn wrapping_sub<T>(self, other: T) -> u256 where
    T: Into<u256>, 

Wrapping (modular) subtraction. Computes self - rhs, wrapping around at the boundary of the type.

pub fn checked_mul<T>(self, other: T) -> Option<u256> where
    T: Into<u256>, 

Checked integer multiplication. Computes self * rhs, returning None if overflow occurred.

pub fn saturating_mul<T>(self, other: T) -> u256 where
    T: Into<u256>, 

Saturating integer multiplication. Computes self * rhs, saturating at the numeric bounds instead of overflowing.

pub fn overflowing_mul<T>(self, other: T) -> (u256, bool) where
    T: Into<u256>, 

Calculates self * rhs

Returns a tuple of the multiplication along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

pub fn wrapping_mul<T>(self, other: T) -> u256 where
    T: Into<u256>, 

Wrapping (modular) multiplication. Computes self * rhs, wrapping around at the boundary of the type.

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<T> AddAssign<T> for u256 where
    T: Into<u256>, 

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<T> BitAnd<T> for u256 where
    T: Into<u256>, 

type Output = u256

The resulting type after applying the & operator.

fn bitand(self, other: T) -> u256

Performs the & operation.

impl<T> BitAndAssign<T> for u256 where
    T: Into<u256>, 

fn bitand_assign(&mut self, rhs: T)

Performs the &= operation.

impl<T> BitOr<T> for u256 where
    T: Into<u256>, 

type Output = u256

The resulting type after applying the | operator.

fn bitor(self, other: T) -> u256

Performs the | operation.

impl<T> BitOrAssign<T> for u256 where
    T: Into<u256>, 

fn bitor_assign(&mut self, rhs: T)

Performs the |= operation.

impl<T> BitXor<T> for u256 where
    T: Into<u256>, 

type Output = u256

The resulting type after applying the ^ operator.

fn bitxor(self, other: T) -> u256

Performs the ^ operation.

impl<T> BitXorAssign<T> for u256 where
    T: Into<u256>, 

fn bitxor_assign(&mut self, rhs: T)

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 Debug for u256

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

Formats the value using the given formatter.

impl Default for u256

fn default() -> u256

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<T> DivAssign<T> for u256 where
    T: Into<u256>, 

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl From<u128> for u256

fn from(init: u128) -> u256

Performs the conversion.

impl From<u16> for u256

fn from(init: u16) -> u256

Performs the conversion.

impl From<u32> for u256

fn from(init: u32) -> u256

Performs the conversion.

impl From<u64> for u256

fn from(init: u64) -> u256

Performs the conversion.

impl From<u8> for u256

fn from(init: u8) -> u256

Performs the conversion.

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 Index<Range<usize>> for u256

type Output = [u64]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &[u64]

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for u256

type Output = [u64]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &[u64]

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for u256

type Output = [u64]

The returned type after indexing.

fn index(&self, _: RangeFull) -> &[u64]

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for u256

type Output = [u64]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &[u64]

Performs the indexing (container[index]) operation.

impl Index<usize> for u256

type Output = u64

The returned type after indexing.

fn index(&self, index: usize) -> &u64

Performs the indexing (container[index]) operation.

impl<T> Mul<T> for u256 where
    T: Into<u256>, 

type Output = u256

The resulting type after applying the * operator.

fn mul(self, other: T) -> u256

Performs the * operation.

impl<T> MulAssign<T> for u256 where
    T: Into<u256>, 

fn mul_assign(&mut self, rhs: T)

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.

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<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.

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> Rem<T> for u256 where
    T: Into<u256>, 

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

fn rem_assign(&mut self, rhs: T)

Performs the %= operation.

impl Shl<usize> for u256

type Output = u256

The resulting type after applying the << operator.

fn shl(self, shift: usize) -> u256

Performs the << operation.

impl ShlAssign<usize> for u256

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl Shr<usize> for u256

type Output = u256

The resulting type after applying the >> operator.

fn shr(self, shift: usize) -> u256

Performs the >> operation.

impl ShrAssign<usize> for u256

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

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<T> SubAssign<T> for u256 where
    T: Into<u256>, 

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<'a> TryFrom<&'a [u64]> for u256

type Error = ParseLengthError

The type returned in the event of a conversion error.

fn try_from(data: &'a [u64]) -> Result<u256, Self::Error>

Performs the conversion.

impl Copy for u256

impl Eq for u256

impl StructuralEq for u256

impl StructuralPartialEq for u256