Struct NearToken

pub struct NearToken { /* private fields */ }

A wrapper struct for u128 that represents tokens. And provides helpful methods to convert with a proper precision.

Implementations

impl NearToken

pub const fn from_yoctonear(inner: u128) -> NearToken

from_yoctonear is a function that takes value by a number of yocto-near.

Examples

use near_token::NearToken;
assert_eq!( NearToken::from_yoctonear(10u128.pow(21)), NearToken::from_millinear(1))

pub const fn from_millinear(inner: u128) -> NearToken

from_millinear is a function that takes value by a number of mili-near and converts it to an equivalent to the yocto-near.

Examples

use near_token::NearToken;
assert_eq!(NearToken::from_millinear(1), NearToken::from_yoctonear(10u128.pow(21)))

pub const fn from_near(inner: u128) -> NearToken

from_near is a function that takes value by a number of near and converts it to an equivalent to the yocto-near.

Examples

use near_token::NearToken;
assert_eq!(NearToken::from_near(1), NearToken::from_yoctonear(10u128.pow(24)))

pub const fn as_near(&self) -> u128

as_near is a function that converts number of yocto-near to an equivalent to the near.

Examples

use near_token::NearToken;
assert_eq!(NearToken::from_yoctonear(10u128.pow(24)).as_near(), 1)

pub const fn as_millinear(&self) -> u128

as_millinear is a function that converts number of yocto-near to an equivalent to the mili-near.

Examples

use near_token::NearToken;
assert_eq!(NearToken::from_yoctonear(10u128.pow(21)).as_millinear(), 1)

pub const fn as_yoctonear(&self) -> u128

as_yoctonear is a function that shows a number of yocto-near.

Examples

use near_token::NearToken;
assert_eq!(NearToken::from_yoctonear(10).as_yoctonear(), 10)

pub const fn is_zero(&self) -> bool

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

Examples

use near_token::NearToken;
assert_eq!(NearToken::from_yoctonear(0).is_zero(), true)

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

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

Examples

use near_token::NearToken;
use std::u128;
assert_eq!(NearToken::from_yoctonear(u128::MAX -2).checked_add(NearToken::from_yoctonear(2)), Some(NearToken::from_yoctonear(u128::MAX)));
assert_eq!(NearToken::from_yoctonear(u128::MAX -2).checked_add(NearToken::from_yoctonear(3)), None);

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

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

Examples

use near_token::NearToken;
assert_eq!(NearToken::from_yoctonear(2).checked_sub(NearToken::from_yoctonear(2)), Some(NearToken::from_yoctonear(0)));
assert_eq!(NearToken::from_yoctonear(2).checked_sub(NearToken::from_yoctonear(3)), None);

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

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

Examples

use near_token::NearToken;
use std::u128;
assert_eq!(NearToken::from_yoctonear(2).checked_mul(2), Some(NearToken::from_yoctonear(4)));
assert_eq!(NearToken::from_yoctonear(u128::MAX).checked_mul(2), None)

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

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

Examples

use near_token::NearToken;
assert_eq!(NearToken::from_yoctonear(10).checked_div(2), Some(NearToken::from_yoctonear(5)));
assert_eq!(NearToken::from_yoctonear(2).checked_div(0), None);

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

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

Examples

use near_token::NearToken;
assert_eq!(NearToken::from_yoctonear(5).saturating_add(NearToken::from_yoctonear(5)), NearToken::from_yoctonear(10));
assert_eq!(NearToken::from_yoctonear(u128::MAX).saturating_add(NearToken::from_yoctonear(1)), NearToken::from_yoctonear(u128::MAX));

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

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

Examples

use near_token::NearToken;
assert_eq!(NearToken::from_yoctonear(5).saturating_sub(NearToken::from_yoctonear(2)), NearToken::from_yoctonear(3));
assert_eq!(NearToken::from_yoctonear(1).saturating_sub(NearToken::from_yoctonear(2)), NearToken::from_yoctonear(0));

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

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

Examples

use near_token::NearToken;
use std::u128;
assert_eq!(NearToken::from_yoctonear(2).saturating_mul(5), NearToken::from_yoctonear(10));
assert_eq!(NearToken::from_yoctonear(u128::MAX).saturating_mul(2), NearToken::from_yoctonear(u128::MAX));

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

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

Examples

use near_token::NearToken;
assert_eq!(NearToken::from_yoctonear(10).saturating_div(2), NearToken::from_yoctonear(5));
assert_eq!(NearToken::from_yoctonear(10).saturating_div(0), NearToken::from_yoctonear(0))

pub fn exact_amount_display(&self) -> String

Formats the NearToken and displays the amount in NEAR or yoctoNEAR depending on the value.

Examples

use near_token::NearToken;
assert_eq!(NearToken::from_yoctonear(10_u128.pow(24)).exact_amount_display(), "1 NEAR");
assert_eq!(NearToken::from_yoctonear(15 * 10_u128.pow(23)).exact_amount_display(), "1.5 NEAR");
assert_eq!(NearToken::from_yoctonear(500).exact_amount_display(), "500 yoctoNEAR");
assert_eq!(NearToken::from_yoctonear(0).exact_amount_display(), "0 NEAR");

Trait Implementations

impl BorshDeserialize for NearToken

fn deserialize_reader<__R>(reader: &mut __R) -> Result<NearToken, Error>

where __R: Read,

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSchema for NearToken

fn declaration() -> String

Get the name of the type without brackets.

fn add_definitions_recursively(definitions: &mut BTreeMap<String, Definition>)

Recursively, using DFS, add type definitions required for this type. Type definition partially explains how to serialize/deserialize a type.

impl BorshSerialize for NearToken

fn serialize<__W>(&self, writer: &mut __W) -> Result<(), Error>

where __W: Write,

impl Clone for NearToken

fn clone(&self) -> NearToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NearToken

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

Formats the value using the given formatter.

impl Default for NearToken

fn default() -> NearToken

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NearToken

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NearToken

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

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

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

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

Formats the value using the given formatter.

impl FromStr for NearToken

type Err = NearTokenError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<NearToken, <NearToken as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for NearToken

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

where __H: Hasher,

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

fn is_referenceable() -> bool

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

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 schema_id() -> Cow<'static, str>

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

impl Ord for NearToken

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

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

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for NearToken

impl Eq for NearToken

impl StructuralPartialEq for NearToken