Struct Uint64

pub struct Uint64(/* private fields */);

A thin wrapper around u64 that is using strings for JSON encoding/decoding, such that the full u64 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 u64 to get the value out:

let a = Uint64::from(42u64);
assert_eq!(a.u64(), 42);

let b = Uint64::from(70u32);
assert_eq!(b.u64(), 70);

Implementations

impl Uint64

pub const MAX: Self

pub const MIN: Self

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

Creates a Uint64(value).

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

pub const fn zero() -> Self

Creates a Uint64(0)

pub const fn one() -> Self

Creates a Uint64(1)

pub const fn u64(&self) -> u64

Returns a copy of the internal data

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

Constructs new value from big endian bytes

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

Constructs new value from little endian bytes

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

Returns a copy of the number as big endian bytes.

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

Returns a copy of the number as little endian bytes.

pub const fn is_zero(&self) -> bool

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

pub fn ilog2(self) -> u32

Returns the base 2 logarithm of the number, rounded down.

Panics

This function will panic if self is zero.

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

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<u64>, B: Into<u64>>( &self, numerator: A, denominator: B, ) -> Result<Uint64, 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<Self>) -> Uint128

Multiplies two Uint64/u64 values without overflow, producing an Uint128.

Examples

use cosmwasm_std::Uint64;

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

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

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

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 strict_add(self, rhs: Self) -> Self

Strict integer addition. Computes self + rhs, panicking if overflow occurred.

This is the same as Uint64::add but const.

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

Strict integer subtraction. Computes self - rhs, panicking if overflow occurred.

This is the same as Uint64::sub but const.

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

impl Uint64

pub fn checked_mul_floor<F: Fraction<T>, T: Into<Uint64>>( self, rhs: F, ) -> Result<Self, CheckedMultiplyFractionError>

Multiply self with a struct implementing Fraction (e.g. crate::Decimal). Result is rounded down.

Examples

use cosmwasm_std::Uint128;
let fraction = (8u128, 21u128);
let res = Uint128::new(123456).checked_mul_floor(fraction).unwrap();
assert_eq!(Uint128::new(47030), res); // 47030.8571 rounds down

pub fn mul_floor<F: Fraction<T>, T: Into<Uint64>>(self, rhs: F) -> Self

Same operation as checked_mul_floor except unwrapped

pub fn checked_mul_ceil<F: Fraction<T>, T: Into<Uint64>>( self, rhs: F, ) -> Result<Self, CheckedMultiplyFractionError>

Multiply self with a struct implementing Fraction (e.g. crate::Decimal). Result is rounded up.

Examples

use cosmwasm_std::Uint128;
let fraction = (8u128, 21u128);
let res = Uint128::new(123456).checked_mul_ceil(fraction).unwrap();
assert_eq!(Uint128::new(47031), res); // 47030.8571 rounds up

pub fn mul_ceil<F: Fraction<T>, T: Into<Uint64>>(self, rhs: F) -> Self

Same operation as checked_mul_ceil except unwrapped

pub fn checked_div_floor<F: Fraction<T>, T: Into<Uint64>>( self, rhs: F, ) -> Result<Self, CheckedMultiplyFractionError>

where Self: Sized,

Divide self with a struct implementing Fraction (e.g. crate::Decimal). Result is rounded down.

Examples

use cosmwasm_std::Uint128;
let fraction = (4u128, 5u128);
let res = Uint128::new(789).checked_div_floor(fraction).unwrap();
assert_eq!(Uint128::new(986), res); // 986.25 rounds down

pub fn div_floor<F: Fraction<T>, T: Into<Uint64>>(self, rhs: F) -> Self

where Self: Sized,

Same operation as checked_div_floor except unwrapped

pub fn checked_div_ceil<F: Fraction<T>, T: Into<Uint64>>( self, rhs: F, ) -> Result<Self, CheckedMultiplyFractionError>

where Self: Sized,

Divide self with a struct implementing Fraction (e.g. crate::Decimal). Result is rounded up.

Examples

use cosmwasm_std::Uint128;
let fraction = (4u128, 5u128);
let res = Uint128::new(789).checked_div_ceil(fraction).unwrap();
assert_eq!(Uint128::new(987), res); // 986.25 rounds up

pub fn div_ceil<F: Fraction<T>, T: Into<Uint64>>(self, rhs: F) -> Self

where Self: Sized,

Same operation as checked_div_ceil except unwrapped

Trait Implementations

impl Add<&Uint64> for &Uint64

type Output = <Uint64 as Add>::Output

The resulting type after applying the + operator.

fn add(self, other: &Uint64) -> <Uint64 as Add<Uint64>>::Output

Performs the + operation.

impl Add<&Uint64> for Uint64

type Output = <Uint64 as Add>::Output

The resulting type after applying the + operator.

fn add(self, other: &Uint64) -> <Uint64 as Add<Uint64>>::Output

Performs the + operation.

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

type Output = <Uint64 as Add>::Output

The resulting type after applying the + operator.

fn add(self, other: Uint64) -> <Uint64 as Add<Uint64>>::Output

Performs the + operation.

impl Add for Uint64

type Output = Uint64

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

Performs the += operation.

impl AddAssign for Uint64

fn add_assign(&mut self, rhs: Uint64)

Performs the += operation.

impl Clone for Uint64

fn clone(&self) -> Uint64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Uint64

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

Formats the value using the given formatter.

impl Default for Uint64

fn default() -> Uint64

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Uint64

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserializes from an integer string using base 10.

See the Serialize documentation for a few more words on the encoding of the UintXXX/IntYYY family.

impl Display for Uint64

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

Formats the value using the given formatter.

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

type Output = Uint64

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Uint64

type Output = Uint64

The resulting type after applying the / operator.

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

Performs the / operation.

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

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

Performs the /= operation.

impl DivAssign for Uint64

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<Uint64> for Int128

fn from(val: Uint64) -> Self

Converts to this type from the input type.

impl From<Uint64> for Int256

fn from(val: Uint64) -> Self

Converts to this type from the input type.

impl From<Uint64> for Int512

fn from(val: Uint64) -> Self

Converts to this type from the input type.

impl From<Uint64> for String

fn from(original: Uint64) -> 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<Uint64> for Uint256

fn from(val: Uint64) -> Self

Converts to this type from the input type.

impl From<Uint64> for Uint512

fn from(val: Uint64) -> Self

Converts to this type from the input type.

impl From<Uint64> for u128

fn from(value: Uint64) -> Self

Converts to this type from the input type.

impl From<Uint64> for u64

fn from(value: Uint64) -> Self

Converts to this type from the input type.

impl From<u16> for Uint64

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Uint64

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Uint64

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Uint64

fn from(value: u8) -> Self

Converts to this type from the input type.

impl JsonSchema for Uint64

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &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<&Uint64> for &Uint64

type Output = <Uint64 as Mul>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Uint64> for Uint64

type Output = <Uint64 as Mul>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = <Uint64 as Mul>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Uint64

type Output = Uint64

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<&Uint64> for Uint64

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

Performs the *= operation.

impl MulAssign for Uint64

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Not for Uint64

type Output = Uint64

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for Uint64

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

Restrict a value to a certain interval.

impl PartialEq<&Uint64> for Uint64

fn eq(&self, rhs: &&Uint64) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> PartialEq<Uint64> for &'a Uint64

fn eq(&self, rhs: &Uint64) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for Uint64

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Uint64

fn partial_cmp(&self, other: &Uint64) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Rem<&Uint64> for &Uint64

type Output = <Uint64 as Rem>::Output

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<&Uint64> for Uint64

type Output = <Uint64 as Rem>::Output

The resulting type after applying the % operator.

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

Performs the % operation.

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

type Output = <Uint64 as Rem>::Output

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem for Uint64

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

Panics

This operation will panic if rhs is zero.

type Output = Uint64

The resulting type after applying the % operator.

impl RemAssign<&Uint64> for Uint64

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

Performs the %= operation.

impl RemAssign for Uint64

fn rem_assign(&mut self, rhs: Uint64)

Performs the %= operation.

impl Serialize for Uint64

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

where S: Serializer,

Serializes as an integer string using base 10.

We consistently serialize all UintXXX and IntYYY types as strings in JSON to ensure the best possible compatibility with clients. E.g. JavaScript and jq only support up to ~53bit numbers without losing precision, making it hard to use serialized u64s on other systems than Rust or Go. Uint64/Int64 ensure the full 64 bit range is supported. For larger integers, the use of strings is pretty much the only reasonable way to store them in JSON.

For binary encodings (notably MessagePack) strings are used too. The reason is that in MessagePack integers are limited to 64 bit and we strive for consistent encoding within the UintXXX/IntYYY family. Also for small to mid sized values, decimal strings are often more compact than a fixed-length binary encoding.

Examples

Serialize to JSON:

let value = Uint64::new(17);
let serialized = to_json_vec(&value).unwrap();
assert_eq!(serialized, b"\"17\"");

Serialize to MessagePack:

let value = Uint64::new(17);
let serialized = to_msgpack_vec(&value).unwrap();
assert_eq!(serialized, [0b10100000 ^ 2, b'1', b'7']); // string of lengths 2 with value "17"

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

type Output = Uint64

The resulting type after applying the << operator.

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

Performs the << operation.

impl Shl<u32> for Uint64

type Output = Uint64

The resulting type after applying the << operator.

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

Performs the << operation.

impl<'a> ShlAssign<&'a u32> for Uint64

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

Performs the <<= operation.

impl ShlAssign<u32> for Uint64

fn shl_assign(&mut self, rhs: u32)

Performs the <<= operation.

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

type Output = Uint64

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl Shr<u32> for Uint64

type Output = Uint64

The resulting type after applying the >> operator.

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

Performs the >> operation.

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

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

Performs the >>= operation.

impl ShrAssign<u32> for Uint64

fn shr_assign(&mut self, rhs: u32)

Performs the >>= operation.

impl Sub<&Uint64> for &Uint64

type Output = <Uint64 as Sub>::Output

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&Uint64> for Uint64

type Output = <Uint64 as Sub>::Output

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = <Uint64 as Sub>::Output

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Uint64

type Output = Uint64

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&Uint64> for Uint64

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

Performs the -= operation.

impl SubAssign for Uint64

fn sub_assign(&mut self, rhs: Uint64)

Performs the -= operation.

impl<A> Sum<A> for Uint64

where Self: Add<A, Output = Self>,

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

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<&str> for Uint64

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

type Error = ConversionOverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Int256> for Uint64

type Error = ConversionOverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Int512> for Uint64

type Error = ConversionOverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Int64> for Uint64

type Error = ConversionOverflowError

The type returned in the event of a conversion error.

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

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 Uint64

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 TryFrom<Uint64> for Int64

type Error = ConversionOverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Uint64

impl Eq for Uint64

impl StructuralPartialEq for Uint64