Struct cosmwasm_std::Uint128

pub struct Uint128(pub u128);

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 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 fn u128(&self) -> u128

Returns a copy of the internal data

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_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, other: u32) -> Self

impl Uint128

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

Returns self * numerator / denominator

Trait Implementations

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

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Uint128> for Uint128

type Output = Self

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.

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

Performs copy-assignment from source.

impl Copy for Uint128

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

impl From<u128> for Uint128

fn from(val: u128) -> Self

Performs the conversion.

impl From<u16> for Uint128

fn from(val: u16) -> Self

Performs the conversion.

impl From<u32> for Uint128

fn from(val: u32) -> Self

Performs the conversion.

impl From<u64> for Uint128

fn from(val: u64) -> Self

Performs the conversion.

impl From<u8> for Uint128

fn from(val: u8) -> Self

Performs the conversion.

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.

pub fn is_referenceable() -> bool

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

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 = Self

The resulting type after applying the * operator.

fn mul(self, rhs: Decimal) -> Self::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 Ord for Uint128

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

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

This method tests for !=.

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.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub 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 Uint128

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

Serializes as an integer string using base 10

impl StructuralEq for Uint128

impl StructuralPartialEq for Uint128

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

fn sum<I: Iterator<Item = &'a Uint128>>(iter: I) -> Self

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

impl Sum<Uint128> for Uint128

fn sum<I: Iterator<Item = Uint128>>(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.