Struct num256::uint256::Uint256

pub struct Uint256(pub BigUint);

Tuple Fields

0: BigUint

Implementations

impl Uint256

pub fn from_bytes_le(slice: &[u8]) -> Uint256

pub fn from_bytes_be(slice: &[u8]) -> Uint256

pub fn from_str_radix(s: &str, radix: u32) -> Result<Uint256, ParseBigIntError>

pub fn to_int256(&self) -> Option<Int256>

Converts value to a signed 256 bit integer

Methods from Deref<Target = BigUint>

pub fn to_bytes_be(&self) -> Vec<u8, Global>

Returns the byte representation of the BigUint in big-endian byte order.

Examples

use num_bigint::BigUint;

let i = BigUint::parse_bytes(b"1125", 10).unwrap();
assert_eq!(i.to_bytes_be(), vec![4, 101]);

pub fn to_bytes_le(&self) -> Vec<u8, Global>

Returns the byte representation of the BigUint in little-endian byte order.

Examples

use num_bigint::BigUint;

let i = BigUint::parse_bytes(b"1125", 10).unwrap();
assert_eq!(i.to_bytes_le(), vec![101, 4]);

pub fn to_u32_digits(&self) -> Vec<u32, Global>

Returns the u32 digits representation of the BigUint ordered least significant digit first.

Examples

use num_bigint::BigUint;

assert_eq!(BigUint::from(1125u32).to_u32_digits(), vec![1125]);
assert_eq!(BigUint::from(4294967295u32).to_u32_digits(), vec![4294967295]);
assert_eq!(BigUint::from(4294967296u64).to_u32_digits(), vec![0, 1]);
assert_eq!(BigUint::from(112500000000u64).to_u32_digits(), vec![830850304, 26]);

pub fn to_str_radix(&self, radix: u32) -> String

Returns the integer formatted as a string in the given radix. radix must be in the range 2...36.

Examples

use num_bigint::BigUint;

let i = BigUint::parse_bytes(b"ff", 16).unwrap();
assert_eq!(i.to_str_radix(16), "ff");

pub fn to_radix_be(&self, radix: u32) -> Vec<u8, Global>

Returns the integer in the requested base in big-endian digit order. The output is not given in a human readable alphabet but as a zero based u8 number. radix must be in the range 2...256.

Examples

use num_bigint::BigUint;

assert_eq!(BigUint::from(0xFFFFu64).to_radix_be(159),
           vec![2, 94, 27]);
// 0xFFFF = 65535 = 2*(159^2) + 94*159 + 27

pub fn to_radix_le(&self, radix: u32) -> Vec<u8, Global>

Returns the integer in the requested base in little-endian digit order. The output is not given in a human readable alphabet but as a zero based u8 number. radix must be in the range 2...256.

Examples

use num_bigint::BigUint;

assert_eq!(BigUint::from(0xFFFFu64).to_radix_le(159),
           vec![27, 94, 2]);
// 0xFFFF = 65535 = 27 + 94*159 + 2*(159^2)

pub fn bits(&self) -> usize

Determines the fewest bits necessary to express the BigUint.

pub fn modpow(&self, exponent: &BigUint, modulus: &BigUint) -> BigUint

Returns (self ^ exponent) % modulus.

Panics if the modulus is zero.

pub fn sqrt(&self) -> BigUint

Returns the truncated principal square root of self – see Roots::sqrt

pub fn cbrt(&self) -> BigUint

Returns the truncated principal cube root of self – see Roots::cbrt.

pub fn nth_root(&self, n: u32) -> BigUint

Returns the truncated principal nth root of self – see Roots::nth_root.

Trait Implementations

impl Add<Uint256> for Uint256

type Output = Uint256

The resulting type after applying the + operator.

fn add(self, Uint256: Uint256) -> Uint256

Performs the + operation.

impl AddAssign<Uint256> for Uint256

fn add_assign(&mut self, Uint256: Uint256)

Performs the += operation.

impl Bounded for Uint256

fn min_value() -> Self

Returns the smallest finite number this type can represent

fn max_value() -> Self

Returns the largest finite number this type can represent

impl CheckedAdd for Uint256

fn checked_add(&self, Uint256: &Uint256) -> Option<Uint256>

Adds two numbers, checking for overflow. If overflow happens, None is returned.

impl CheckedDiv for Uint256

fn checked_div(&self, Uint256: &Uint256) -> Option<Uint256>

Divides two numbers, checking for underflow, overflow and division by zero. If any of that happens, None is returned.

impl CheckedMul for Uint256

fn checked_mul(&self, Uint256: &Uint256) -> Option<Uint256>

Multiplies two numbers, checking for underflow or overflow. If underflow or overflow happens, None is returned.

impl CheckedSub for Uint256

fn checked_sub(&self, Uint256: &Uint256) -> Option<Uint256>

Subtracts two numbers, checking for underflow. If underflow happens, None is returned.

impl Clone for Uint256

fn clone(&self) -> Uint256

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Uint256

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

Formats the value using the given formatter.

impl Default for Uint256

fn default() -> Uint256

Returns the “default value” for a type.

impl Deref for Uint256

type Target = BigUint

The resulting type after dereferencing.

fn deref(&self) -> &BigUint

Dereferences the value.

impl<'de> Deserialize<'de> for Uint256

fn deserialize<D>(deserializer: D) -> Result<Uint256, D::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Uint256

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

Formats the value using the given formatter.

impl Div<Uint256> for Uint256

type Output = Uint256

The resulting type after applying the / operator.

fn div(self, Uint256: Uint256) -> Uint256

Performs the / operation.

impl DivAssign<Uint256> for Uint256

fn div_assign(&mut self, Uint256: Uint256)

Performs the /= operation.

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

fn from(n: &'a [u8]) -> Uint256

Converts to this type from the input type.

impl From<[u8; 32]> for Uint256

fn from(n: [u8; 32]) -> Uint256

Converts to this type from the input type.

impl From<u128> for Uint256

fn from(n: u128) -> Self

Converts to this type from the input type.

impl From<u16> for Uint256

fn from(n: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Uint256

fn from(n: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Uint256

fn from(n: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Uint256

fn from(n: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Uint256

fn from(n: usize) -> Self

Converts to this type from the input type.

impl FromPrimitive for Uint256

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl FromStr for Uint256

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for Uint256

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Into<[u8; 32]> for Uint256

fn into(self) -> [u8; 32]

Converts this type into the (usually inferred) input type.

impl LowerHex for Uint256

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

Formats the value using the given formatter.

impl Mul<Uint256> for Uint256

type Output = Uint256

The resulting type after applying the * operator.

fn mul(self, Uint256: Uint256) -> Uint256

Performs the * operation.

impl MulAssign<Uint256> for Uint256

fn mul_assign(&mut self, Uint256: Uint256)

Performs the *= operation.

impl Ord for Uint256

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Uint256> for Uint256

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Uint256> for Uint256

fn partial_cmp(&self, other: &Uint256) -> 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 Serialize for Uint256

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<Uint256> for Uint256

type Output = Uint256

The resulting type after applying the - operator.

fn sub(self, Uint256: Uint256) -> Uint256

Performs the - operation.

impl SubAssign<Uint256> for Uint256

fn sub_assign(&mut self, Uint256: Uint256)

Performs the -= operation.

impl ToPrimitive for Uint256

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

impl UpperHex for Uint256

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

Formats the value using the given formatter.

impl Zero for Uint256

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Eq for Uint256

impl StructuralEq for Uint256

impl StructuralPartialEq for Uint256