Struct clarity::Uint256

pub struct Uint256(pub BUint<bnum::::types::U256::{constant#0}>);

Tuple Fields

0: BUint<bnum::::types::U256::{constant#0}>

Implementations

impl Uint256

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

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

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

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

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

Converts value to a signed 256 bit integer

pub fn sqrt(&self) -> Uint256

Square root

Methods from Deref<Target = BUint<bnum::::types::U256::{constant#0}>>

pub fn bits(&self) -> u32

Returns the smallest number of bits necessary to represent self.

This is equal to the size of the type in bits minus the leading zeros of self.

Examples

use bnum::types::U256;

assert_eq!(U256::from(0b1111001010100u16).bits(), 13);
assert_eq!(U256::ZERO.bits(), 0);

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

Returns a boolean representing the bit in the given position (true if the bit is set). The least significant bit is at index 0, the most significant bit is at index Self::BITS - 1

Examples

use bnum::types::U256;

let n = U256::from(0b001010100101010101u32);
assert!(n.bit(0));
assert!(!n.bit(1));
assert!(!n.bit(U256::BITS - 1));

pub fn digits(&self) -> &[u64; N]

Returns the digits stored in self as an array. Digits are little endian (least significant digit first).

pub fn is_zero(&self) -> bool

Returns whether self is zero.

Examples

use bnum::types::U256;

assert!(U256::ZERO.is_zero());
assert!(!U256::ONE.is_zero());

pub fn is_one(&self) -> bool

Returns whether self is one.

Examples

use bnum::types::U256;

assert!(U256::ONE.is_one());
assert!(!U256::MAX.is_one());

pub const MIN: BUint<N> = _

pub const MAX: BUint<N> = _

pub const BITS: u32 = _

pub const BYTES: u32 = _

pub const ZERO: BUint<N> = Self::MIN

pub const ONE: BUint<N> = _

pub const TWO: BUint<N> = _

pub const THREE: BUint<N> = _

pub const FOUR: BUint<N> = _

pub const FIVE: BUint<N> = _

pub const SIX: BUint<N> = _

pub const SEVEN: BUint<N> = _

pub const EIGHT: BUint<N> = _

pub const NINE: BUint<N> = _

pub const TEN: BUint<N> = _

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

Returns the integer as a string in the given radix.

Panics

This function panics if radix is not in the range from 2 to 36 inclusive.

Examples

use bnum::types::U512;

let src = "934857djkfghhkdfgbf9345hdfkh";
let n = U512::from_str_radix(src, 36).unwrap();
assert_eq!(n.to_str_radix(36), src);

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

Returns the integer in the given base in big-endian digit order.

Panics

This function panics if radix is not in the range from 2 to 256 inclusive.

use bnum::types::U512;

let digits = &[3, 55, 60, 100, 5, 0, 5, 88];
let n = U512::from_radix_be(digits, 120).unwrap();
assert_eq!(n.to_radix_be(120), digits);

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

Returns the integer in the given base in little-endian digit order.

Panics

This function panics if radix is not in the range from 2 to 256 inclusive.

use bnum::types::U512;

let digits = &[1, 67, 88, 200, 55, 68, 87, 120, 178];
let n = U512::from_radix_le(digits, 250).unwrap();
assert_eq!(n.to_radix_le(250), digits);

Trait Implementations

impl Add for Uint256

type Output = Uint256

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Uint256

fn add_assign(&mut self, _: Uint256)

Performs the += operation.

impl Bounded for Uint256

fn min_value() -> Uint256

Returns the smallest finite number this type can represent

fn max_value() -> Uint256

Returns the largest finite number this type can represent

impl CheckedAdd for Uint256

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

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

impl CheckedDiv for Uint256

fn checked_div(&self, _: &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) -> 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) -> 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<(), Error>

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 = BUint<bnum::::types::U256::{constant#0}>

The resulting type after dereferencing.

fn deref(&self) -> &BUint<bnum::::types::U256::{constant#0}>

Dereferences the value.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Uint256

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

Formats the value using the given formatter.

impl Div for Uint256

type Output = Uint256

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for Uint256

fn div_assign(&mut self, _: 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<&Uint256> for AbiToken

fn from(v: &Uint256) -> AbiToken

Converts to this type from the input type.

impl From<&Uint256> for RlpToken

fn from(value: &Uint256) -> Self

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<Uint256> for AbiToken

fn from(v: Uint256) -> AbiToken

Converts to this type from the input type.

impl From<Uint256> for RlpToken

fn from(value: Uint256) -> Self

Converts to this type from the input type.

impl From<u128> for Uint256

fn from(n: u128) -> Uint256

Converts to this type from the input type.

impl From<u16> for Uint256

fn from(n: u16) -> Uint256

Converts to this type from the input type.

impl From<u32> for Uint256

fn from(n: u32) -> Uint256

Converts to this type from the input type.

impl From<u64> for Uint256

fn from(n: u64) -> Uint256

Converts to this type from the input type.

impl From<u8> for Uint256

fn from(n: u8) -> Uint256

Converts to this type from the input type.

impl From<usize> for Uint256

fn from(n: usize) -> Uint256

Converts to this type from the input type.

impl FromPrimitive for Uint256

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

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

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_i128(n: i128) -> Option<Uint256>

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

Converts an u128 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.

impl FromStr for Uint256

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Uint256, <Uint256 as FromStr>::Err>

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

impl Hash for Uint256

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 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<(), Error>

Formats the value using the given formatter.

impl Mul for Uint256

type Output = Uint256

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for Uint256

fn mul_assign(&mut self, _: Uint256)

Performs the *= operation.

impl Num for Uint256

type FromStrRadixErr = ParseError

fn from_str_radix( str: &str, radix: u32 ) -> Result<Uint256, <Uint256 as Num>::FromStrRadixErr>

Convert from a string and radix (typically 2..=36).

impl One for Uint256

fn one() -> Uint256

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl Ord for Uint256

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq 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 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 Rem for Uint256

type Output = Uint256

The resulting type after applying the % operator.

fn rem(self, _: Uint256) -> Uint256

Performs the % operation.

impl RemAssign for Uint256

fn rem_assign(&mut self, _: Uint256)

Performs the %= operation.

impl Serialize for Uint256

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Shl for Uint256

type Output = Uint256

The resulting type after applying the << operator.

fn shl(self, _: Uint256) -> Uint256

Performs the << operation.

impl ShlAssign for Uint256

fn shl_assign(&mut self, _: Uint256)

Performs the <<= operation.

impl Shr for Uint256

type Output = Uint256

The resulting type after applying the >> operator.

fn shr(self, _: Uint256) -> Uint256

Performs the >> operation.

impl ShrAssign for Uint256

fn shr_assign(&mut self, _: Uint256)

Performs the >>= operation.

impl Sub for Uint256

type Output = Uint256

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Uint256

fn sub_assign(&mut self, _: 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_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.

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.

impl TryFrom<Int256> for Uint256

type Error = ()

The type returned in the event of a conversion error.

fn try_from( value: Int256 ) -> Result<Uint256, <Uint256 as TryFrom<Int256>>::Error>

Performs the conversion.

impl TryFrom<Uint256> for Address

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Uint256) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Uint256> for Int256

type Error = ()

The type returned in the event of a conversion error.

fn try_from( value: Uint256 ) -> Result<Int256, <Int256 as TryFrom<Uint256>>::Error>

Performs the conversion.

impl UpperHex for Uint256

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

Formats the value using the given formatter.

impl Zero for Uint256

fn zero() -> Uint256

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 Copy for Uint256

impl Eq for Uint256

impl StructuralPartialEq for Uint256