Struct cosmwasm_std::Uint256

pub struct Uint256(_);

An implementation of u256 that is using strings for JSON encoding/decoding, such that the full u256 range can be used for clients that convert JSON numbers to floats, like JavaScript and jq.

Examples

Use from to create instances out of primitive uint types or new to provide big endian bytes:

let a = Uint256::from(258u128);
let b = Uint256::new([
    0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8,
    0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8,
    0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 0u8,
    0u8, 0u8, 0u8, 0u8, 0u8, 0u8, 1u8, 2u8,
]);
assert_eq!(a, b);

Implementations

impl Uint256

pub const MAX: Uint256

pub const fn new(value: [u8; 32]) -> Self

Creates a Uint256(value) from a big endian representation. It’s just an alias for Uint256::from_be_bytes.

This method is less flexible than from but can be called in a const context.

pub const fn zero() -> Self

Creates a Uint256(0)

pub const fn from_be_bytes(data: [u8; 32]) -> Self

pub const fn from_le_bytes(data: [u8; 32]) -> Self

pub const fn from_uint128(num: Uint128) -> Self

A conversion from Uint128 that, unlike the one provided by the From trait, can be used in a const context.

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

Returns a copy of the number as big endian bytes.

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

Returns a copy of the number as little endian bytes.

pub fn is_zero(&self) -> bool

pub fn checked_add(self, other: Self) -> Result<Self, OverflowError>

pub fn checked_sub(self, other: Self) -> Result<Self, OverflowError>

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

pub fn checked_div(self, other: Self) -> Result<Self, DivideByZeroError>

pub fn checked_rem(self, other: Self) -> Result<Self, DivideByZeroError>

pub fn checked_pow(self, exp: u32) -> Result<Self, OverflowError>

pub fn pow(self, exp: u32) -> Self

pub fn checked_shr(self, other: u32) -> Result<Self, OverflowError>

pub fn checked_shl(self, other: u32) -> Result<Self, OverflowError>

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

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

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

impl Uint256

pub fn multiply_ratio<A: Into<Uint256>, B: Into<Uint256>>(
    &self,
    numerator: A,
    denominator: B
) -> Uint256

Returns self * numerator / denominator

pub fn full_mul(self, rhs: impl Into<Uint256>) -> Uint512

Multiplies two u256 values without overflow, producing an Uint512.

Examples

use cosmwasm_std::Uint256;

let a = Uint256::MAX;
let result = a.full_mul(2u32);
assert_eq!(
    result.to_string(),
    "231584178474632390847141970017375815706539969331281128078915168015826259279870",
);

Trait Implementations

impl<'a> Add<&'a Uint256> for Uint256

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: &'a Uint256) -> Self

Performs the + operation.

impl Add<Uint256> for Uint256

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl<'a> AddAssign<&'a Uint256> for Uint256

fn add_assign(&mut self, rhs: &'a Uint256)

Performs the += operation.

impl AddAssign<Uint256> for Uint256

fn add_assign(&mut self, rhs: Uint256)

Performs the += operation.

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<'de> Deserialize<'de> for Uint256

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

Deserialized from an integer string using base 10

impl Display for Uint256

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

Formats the value using the given formatter.

impl<'a> Div<&'a Uint256> for Uint256

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: &'a Uint256) -> Self::Output

Performs the / operation.

impl Div<Uint256> for Decimal256

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: Uint256) -> Self::Output

Performs the / operation.

impl Div<Uint256> for Uint256

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl<'a> DivAssign<&'a Uint256> for Uint256

fn div_assign(&mut self, rhs: &'a Uint256)

Performs the /= operation.

impl DivAssign<Uint256> for Decimal256

fn div_assign(&mut self, rhs: Uint256)

Performs the /= operation.

impl DivAssign<Uint256> for Uint256

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl Fraction<Uint256> for Decimal256

fn inv(&self) -> Option<Self>

Returns the multiplicative inverse 1/d for decimal d.

If d is zero, none is returned.

fn numerator(&self) -> Uint256

Returns the numerator p

fn denominator(&self) -> Uint256

Returns the denominator q

impl From<Uint128> for Uint256

fn from(val: Uint128) -> Self

Performs the conversion.

impl From<Uint256> for String

fn from(original: Uint256) -> Self

Performs the conversion.

impl From<Uint256> for Uint512

fn from(val: Uint256) -> Self

Performs the conversion.

impl From<Uint64> for Uint256

fn from(val: Uint64) -> Self

Performs the conversion.

impl From<u128> for Uint256

fn from(val: u128) -> Self

Performs the conversion.

impl From<u16> for Uint256

fn from(val: u16) -> Self

Performs the conversion.

impl From<u32> for Uint256

fn from(val: u32) -> Self

Performs the conversion.

impl From<u64> for Uint256

fn from(val: u64) -> Self

Performs the conversion.

impl From<u8> for Uint256

fn from(val: u8) -> Self

Performs the conversion.

impl FromStr for Uint256

type Err = StdError

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

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

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

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Uint256) -> Self::Output

Performs the * operation.

impl Mul<Decimal256> for Uint256

Both du and ud with d: Decimal256 and u: Uint256 returns an Uint256. There is no specific reason for this decision other than the initial use cases we have. If you need a Decimal256 result for the same calculation, use Decimal256(du) or Decimal256(ud).

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: Decimal256) -> Self::Output

Performs the * operation.

impl Mul<Uint256> for Decimal256

type Output = Uint256

The resulting type after applying the * operator.

fn mul(self, rhs: Uint256) -> Self::Output

Performs the * operation.

impl Mul<Uint256> for Uint256

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<'a> MulAssign<&'a Uint256> for Uint256

fn mul_assign(&mut self, rhs: &'a Uint256)

Performs the *= operation.

impl MulAssign<Uint256> for Uint256

fn mul_assign(&mut self, rhs: Self)

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) -> 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<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: &Uint256) -> bool

This method tests for !=.

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, 

Serializes as an integer string using base 10

impl<'a> Shl<&'a u32> for Uint256

type Output = Self

The resulting type after applying the << operator.

fn shl(self, rhs: &'a u32) -> Self::Output

Performs the << operation.

impl Shl<u32> for Uint256

type Output = Self

The resulting type after applying the << operator.

fn shl(self, rhs: u32) -> Self::Output

Performs the << operation.

impl<'a> Shr<&'a u32> for Uint256

type Output = Self

The resulting type after applying the >> operator.

fn shr(self, rhs: &'a u32) -> Self::Output

Performs the >> operation.

impl Shr<u32> for Uint256

type Output = Self

The resulting type after applying the >> operator.

fn shr(self, rhs: u32) -> Self::Output

Performs the >> operation.

impl<'a> ShrAssign<&'a u32> for Uint256

fn shr_assign(&mut self, rhs: &'a u32)

Performs the >>= operation.

impl ShrAssign<u32> for Uint256

fn shr_assign(&mut self, rhs: u32)

Performs the >>= operation.

impl<'a> Sub<&'a Uint256> for Uint256

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Uint256) -> Self

Performs the - operation.

impl Sub<Uint256> for Uint256

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl<'a> SubAssign<&'a Uint256> for Uint256

fn sub_assign(&mut self, rhs: &'a Uint256)

Performs the -= operation.

impl SubAssign<Uint256> for Uint256

fn sub_assign(&mut self, rhs: Uint256)

Performs the -= operation.

impl<A> Sum<A> for Uint256 where
    Self: Add<A, Output = Self>, 

fn sum<I: Iterator<Item = A>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<&'_ str> for Uint256

type Error = StdError

The type returned in the event of a conversion error.

fn try_from(val: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Uint256> for Uint128

type Error = ConversionOverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Uint512> for Uint256

type Error = ConversionOverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Uint256

impl Eq for Uint256

impl StructuralEq for Uint256

impl StructuralPartialEq for Uint256