Struct unc_token::UncToken

pub struct UncToken { /* private fields */ }

Implementations

impl UncToken

pub const fn from_attounc(inner: u128) -> Self

from_attounc is a function that takes value by a number of atto-unc.

Examples

use unc_token::UncToken;
assert_eq!( UncToken::from_attounc(10u128.pow(21)), UncToken::from_milliunc(1))

pub const fn from_milliunc(inner: u128) -> Self

from_milliunc is a function that takes value by a number of mili-unc and converts it to an equivalent to the atto-unc.

Examples

use unc_token::UncToken;
assert_eq!(UncToken::from_milliunc(1), UncToken::from_attounc(10u128.pow(21)))

pub const fn from_unc(inner: u128) -> Self

from_unc is a function that takes value by a number of unc and converts it to an equivalent to the atto-unc.

Examples

use unc_token::UncToken;
assert_eq!(UncToken::from_unc(1), UncToken::from_attounc(10u128.pow(24)))

pub const fn as_near(&self) -> u128

as_near is a function that converts number of atto-unc to an equivalent to the unc.

Examples

use unc_token::UncToken;
assert_eq!(UncToken::from_attounc(10u128.pow(24)).as_near(), 1)

pub const fn as_millinear(&self) -> u128

as_millinear is a function that converts number of atto-unc to an equivalent to the mili-unc.

Examples

use unc_token::UncToken;
assert_eq!(UncToken::from_attounc(10u128.pow(21)).as_millinear(), 1)

pub const fn as_attounc(&self) -> u128

as_attounc is a function that shows a number of atto-unc.

Examples

use unc_token::UncToken;
assert_eq!(UncToken::from_attounc(10).as_attounc(), 10)

pub const fn is_zero(&self) -> bool

is_zero is a boolian function that checks UncToken if a UncToken inner is zero, returns true.

Examples

use unc_token::UncToken;
assert_eq!(UncToken::from_attounc(0).is_zero(), true)

pub const fn checked_add(self, rhs: Self) -> Option<Self>

Checked integer addition. Computes self + rhs, returning None if overflow occurred.

Examples

use unc_token::UncToken;
use std::u128;
assert_eq!(UncToken::from_attounc(u128::MAX -2).checked_add(UncToken::from_attounc(2)), Some(UncToken::from_attounc(u128::MAX)));
assert_eq!(UncToken::from_attounc(u128::MAX -2).checked_add(UncToken::from_attounc(3)), None);

pub const fn checked_sub(self, rhs: Self) -> Option<Self>

Checked integer subtraction. Computes self - rhs, returning None if overflow occurred.

Examples

use unc_token::UncToken;
assert_eq!(UncToken::from_attounc(2).checked_sub(UncToken::from_attounc(2)), Some(UncToken::from_attounc(0)));
assert_eq!(UncToken::from_attounc(2).checked_sub(UncToken::from_attounc(3)), None);

pub const fn checked_mul(self, rhs: u128) -> Option<Self>

Checked integer multiplication. Computes self * rhs, returning None if overflow occurred.

Examples

use unc_token::UncToken;
use std::u128;
assert_eq!(UncToken::from_attounc(2).checked_mul(2), Some(UncToken::from_attounc(4)));
assert_eq!(UncToken::from_attounc(u128::MAX).checked_mul(2), None)

pub const fn checked_div(self, rhs: u128) -> Option<Self>

Checked integer division. Computes self / rhs, returning None if rhs == 0.

Examples

use unc_token::UncToken;
assert_eq!(UncToken::from_attounc(10).checked_div(2), Some(UncToken::from_attounc(5)));
assert_eq!(UncToken::from_attounc(2).checked_div(0), None);

pub const fn saturating_add(self, rhs: Self) -> Self

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

Examples

use unc_token::UncToken;
assert_eq!(UncToken::from_attounc(5).saturating_add(UncToken::from_attounc(5)), UncToken::from_attounc(10));
assert_eq!(UncToken::from_attounc(u128::MAX).saturating_add(UncToken::from_attounc(1)), UncToken::from_attounc(u128::MAX));

pub const fn saturating_sub(self, rhs: Self) -> Self

Saturating integer subtraction. Computes self - rhs, saturating at the numeric bounds instead of overflowing.

Examples

use unc_token::UncToken;
assert_eq!(UncToken::from_attounc(5).saturating_sub(UncToken::from_attounc(2)), UncToken::from_attounc(3));
assert_eq!(UncToken::from_attounc(1).saturating_sub(UncToken::from_attounc(2)), UncToken::from_attounc(0));

pub const fn saturating_mul(self, rhs: u128) -> Self

Saturating integer multiplication. Computes self * rhs, saturating at the numeric bounds instead of overflowing.

Examples

use unc_token::UncToken;
use std::u128;
assert_eq!(UncToken::from_attounc(2).saturating_mul(5), UncToken::from_attounc(10));
assert_eq!(UncToken::from_attounc(u128::MAX).saturating_mul(2), UncToken::from_attounc(u128::MAX));

pub const fn saturating_div(self, rhs: u128) -> Self

Saturating integer division. Computes self / rhs, saturating at the numeric bounds instead of overflowing.

Examples

use unc_token::UncToken;
assert_eq!(UncToken::from_attounc(10).saturating_div(2), UncToken::from_attounc(5));
assert_eq!(UncToken::from_attounc(10).saturating_div(0), UncToken::from_attounc(0))

Trait Implementations

impl Clone for UncToken

fn clone(&self) -> UncToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UncToken

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

Formats the value using the given formatter.

impl Default for UncToken

fn default() -> UncToken

Returns the “default value” for a type.

impl Display for UncToken

UncToken Display implementation rounds up the token amount to the relevant precision point. There are 4 breakpoints:

1. exactly 0 UNC
2. <0.001 UNC
3. 0.001 - 0.999 UNC (uses 3 digits after the floating point)

4. 1 UNC (uses 2 digits after the floating point)

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

Formats the value using the given formatter.

impl FromStr for UncToken

type Err = UncTokenError

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 Hash for UncToken

fn hash<__H: Hasher>(&self, state: &mut __H)

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 Ord for UncToken

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

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

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

impl Eq for UncToken

impl StructuralPartialEq for UncToken