Struct cosmwasm_std::Uint128

pub struct Uint128(_);

A thin wrapper around u128 that is using strings for JSON encoding/decoding, such that the full u128 range can be used for clients that convert JSON numbers to floats, like JavaScript and jq.

Examples

Use from to create instances of this and u128 to get the value out:

let a = Uint128::from(123u128);
assert_eq!(a.u128(), 123);

let b = Uint128::from(42u64);
assert_eq!(b.u128(), 42);

let c = Uint128::from(70u32);
assert_eq!(c.u128(), 70);

Implementations

impl Uint128

pub const MAX: Self = _

pub const MIN: Self = _

pub const fn new(value: u128) -> Self

Creates a Uint128(value).

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

pub const fn zero() -> Self

Creates a Uint128(0)

pub const fn one() -> Self

Creates a Uint128(1)

pub const fn u128(&self) -> u128

Returns a copy of the internal data

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

Returns a copy of the number as big endian bytes.

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

Returns a copy of the number as little endian bytes.

pub const fn is_zero(&self) -> bool

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

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

Returns self * numerator / denominator.

Due to the nature of the integer division involved, the result is always floored. E.g. 5 * 99/100 = 4.

pub fn checked_multiply_ratio<A: Into<u128>, B: Into<u128>>(
    &self,
    numerator: A,
    denominator: B
) -> Result<Uint128, CheckedMultiplyRatioError>

Returns self * numerator / denominator.

Due to the nature of the integer division involved, the result is always floored. E.g. 5 * 99/100 = 4.

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

Multiplies two u128 values without overflow, producing an Uint256.

Examples

use cosmwasm_std::Uint128;

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

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_pow(self, exp: u32) -> Result<Self, OverflowError>

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

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

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

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

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

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

pub fn wrapping_pow(self, other: u32) -> Self

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

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

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

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

pub const fn abs_diff(self, other: Self) -> Self

Trait Implementations

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

type Output = Uint128

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Uint128> for Uint128

type Output = Uint128

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

Performs the += operation.

impl AddAssign<Uint128> for Uint128

fn add_assign(&mut self, rhs: Uint128)

Performs the += operation.

impl Clone for Uint128

fn clone(&self) -> Uint128

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Uint128

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

Formats the value using the given formatter.

impl Default for Uint128

fn default() -> Uint128

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Uint128

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

Deserialized from an integer string using base 10

impl Display for Uint128

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

Formats the value using the given formatter.

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

type Output = Uint128

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Uint128> for Decimal

type Output = Decimal

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Uint128> for Uint128

type Output = Uint128

The resulting type after applying the / operator.

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

Performs the / operation.

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

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

Performs the /= operation.

impl DivAssign<Uint128> for Decimal

fn div_assign(&mut self, rhs: Uint128)

Performs the /= operation.

impl DivAssign<Uint128> for Uint128

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl Fraction<Uint128> for Decimal

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

Returns the multiplicative inverse 1/d for decimal d.

If d is zero, none is returned.

fn numerator(&self) -> Uint128

Returns the numerator p

fn denominator(&self) -> Uint128

Returns the denominator q

impl From<Uint128> for String

fn from(original: Uint128) -> Self

Converts to this type from the input type.

impl From<Uint128> for Uint256

fn from(val: Uint128) -> Self

Converts to this type from the input type.

impl From<Uint128> for Uint512

fn from(val: Uint128) -> Self

Converts to this type from the input type.

impl From<Uint128> for u128

fn from(original: Uint128) -> Self

Converts to this type from the input type.

impl From<Uint64> for Uint128

fn from(val: Uint64) -> Self

Converts to this type from the input type.

impl From<u128> for Uint128

fn from(val: u128) -> Self

Converts to this type from the input type.

impl From<u16> for Uint128

fn from(val: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Uint128

fn from(val: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Uint128

fn from(val: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Uint128

fn from(val: u8) -> Self

Converts to this type from the input type.

impl FromStr for Uint128

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 Uint128

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 Mul<&Uint128> for &Uint128

type Output = <Uint128 as Mul<Uint128>>::Output

The resulting type after applying the * operator.

fn mul(self, other: &Uint128) -> <Uint128 as Mul<Uint128>>::Output

Performs the * operation.

impl Mul<&Uint128> for Uint128

type Output = <Uint128 as Mul<Uint128>>::Output

The resulting type after applying the * operator.

fn mul(self, other: &Uint128) -> <Uint128 as Mul<Uint128>>::Output

Performs the * operation.

impl Mul<Decimal> for Uint128

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

type Output = Uint128

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = <Uint128 as Mul<Uint128>>::Output

The resulting type after applying the * operator.

fn mul(self, other: Uint128) -> <Uint128 as Mul<Uint128>>::Output

Performs the * operation.

impl Mul<Uint128> for Decimal

type Output = Uint128

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Uint128> for Uint128

type Output = Uint128

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<&Uint128> for Uint128

fn mul_assign(&mut self, other: &Uint128)

Performs the *= operation.

impl MulAssign<Uint128> for Uint128

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Ord for Uint128

fn cmp(&self, other: &Uint128) -> 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<&Uint128> for Uint128

fn eq(&self, rhs: &&Uint128) -> 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 PartialEq<Uint128> for &Uint128

fn eq(&self, rhs: &Uint128) -> 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 PartialEq<Uint128> for Uint128

fn eq(&self, other: &Uint128) -> 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<Uint128> for Uint128

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

type Output = <Uint128 as Rem<Uint128>>::Output

The resulting type after applying the % operator.

fn rem(self, other: &Uint128) -> <Uint128 as Rem<Uint128>>::Output

Performs the % operation.

impl Rem<&Uint128> for Uint128

type Output = <Uint128 as Rem<Uint128>>::Output

The resulting type after applying the % operator.

fn rem(self, other: &Uint128) -> <Uint128 as Rem<Uint128>>::Output

Performs the % operation.

impl<'a> Rem<Uint128> for &'a Uint128

type Output = <Uint128 as Rem<Uint128>>::Output

The resulting type after applying the % operator.

fn rem(self, other: Uint128) -> <Uint128 as Rem<Uint128>>::Output

Performs the % operation.

impl Rem<Uint128> for Uint128

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

Panics

This operation will panic if rhs is zero.

type Output = Uint128

The resulting type after applying the % operator.

impl RemAssign<&Uint128> for Uint128

fn rem_assign(&mut self, other: &Uint128)

Performs the %= operation.

impl RemAssign<Uint128> for Uint128

fn rem_assign(&mut self, rhs: Uint128)

Performs the %= operation.

impl Serialize for Uint128

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

Serializes as an integer string using base 10

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

type Output = Uint128

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl Shr<u32> for Uint128

type Output = Uint128

The resulting type after applying the >> operator.

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

Performs the >> operation.

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

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

Performs the >>= operation.

impl ShrAssign<u32> for Uint128

fn shr_assign(&mut self, rhs: u32)

Performs the >>= operation.

impl Sub<&Uint128> for &Uint128

type Output = <Uint128 as Sub<Uint128>>::Output

The resulting type after applying the - operator.

fn sub(self, other: &Uint128) -> <Uint128 as Sub<Uint128>>::Output

Performs the - operation.

impl Sub<&Uint128> for Uint128

type Output = <Uint128 as Sub<Uint128>>::Output

The resulting type after applying the - operator.

fn sub(self, other: &Uint128) -> <Uint128 as Sub<Uint128>>::Output

Performs the - operation.

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

type Output = <Uint128 as Sub<Uint128>>::Output

The resulting type after applying the - operator.

fn sub(self, other: Uint128) -> <Uint128 as Sub<Uint128>>::Output

Performs the - operation.

impl Sub<Uint128> for Uint128

type Output = Uint128

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&Uint128> for Uint128

fn sub_assign(&mut self, other: &Uint128)

Performs the -= operation.

impl SubAssign<Uint128> for Uint128

fn sub_assign(&mut self, rhs: Uint128)

Performs the -= operation.

impl<A> Sum<A> for Uint128where
    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 Uint128

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<Uint128> for Uint64

type Error = ConversionOverflowError

The type returned in the event of a conversion error.

fn try_from(value: Uint128) -> 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 Uint128

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 Uint128

impl Eq for Uint128

impl StructuralEq for Uint128

impl StructuralPartialEq for Uint128