Struct NearToken 

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

A NEAR token amount with yoctoNEAR precision (10^-24 NEAR).

Creating Amounts

Use the typed constructors for compile-time safety:

use near_kit::NearToken;

// Preferred: typed constructors (const, zero-cost)
let five_near = NearToken::near(5);
let half_near = NearToken::millinear(500);
let one_yocto = NearToken::yocto(1);

// Also available: longer form
let amount = NearToken::from_near(5);

Parsing from Strings

String parsing is available for runtime input (CLI, config files):

• "5 NEAR" or "5 near" - whole NEAR
• "1.5 NEAR" - decimal NEAR
• "500 milliNEAR" or "500 mNEAR" - milliNEAR
• "1000 yocto" or "1000 yoctoNEAR" - yoctoNEAR

Raw numbers are NOT accepted to prevent unit confusion.

use near_kit::NearToken;

// For runtime/user input only
let amount: NearToken = "5 NEAR".parse().unwrap();

Implementations

impl NearToken

pub const ZERO: Self

Zero NEAR.

pub const ONE_YOCTO: Self

One yoctoNEAR.

pub const ONE_MILLINEAR: Self

One milliNEAR.

pub const ONE_NEAR: Self

One NEAR.

pub const fn near(near: u128) -> Self

Create from whole NEAR (short alias for from_near).

Example

use near_kit::NearToken;

let amount = NearToken::near(5);
assert_eq!(amount, NearToken::from_near(5));

pub const fn millinear(millinear: u128) -> Self

Create from milliNEAR (short alias for from_millinear).

Example

use near_kit::NearToken;

let amount = NearToken::millinear(500); // 0.5 NEAR
assert_eq!(amount, NearToken::from_millinear(500));

pub const fn yocto(yocto: u128) -> Self

Create from yoctoNEAR (short alias for from_yoctonear).

Example

use near_kit::NearToken;

let amount = NearToken::yocto(1);
assert_eq!(amount, NearToken::ONE_YOCTO);

pub const fn from_yoctonear(yocto: u128) -> Self

Create from yoctoNEAR (10^-24 NEAR).

pub const fn from_millinear(millinear: u128) -> Self

Create from milliNEAR (10^-3 NEAR).

pub const fn from_near(near: u128) -> Self

Create from whole NEAR.

pub fn from_near_decimal(s: &str) -> Result<Self, ParseAmountError>

Parse from decimal NEAR (e.g., 1.5 NEAR).

pub const fn as_yoctonear(&self) -> u128

Get the raw yoctoNEAR value.

pub fn as_near_f64(&self) -> f64

Get the value as NEAR (may lose precision).

pub const fn as_near(&self) -> u128

Get whole NEAR (truncated).

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

Checked addition.

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

Checked subtraction.

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

Saturating addition.

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

Saturating subtraction.

pub const fn is_zero(&self) -> bool

Check if zero.

Trait Implementations

impl Add for NearToken

type Output = NearToken

The resulting type after applying the + operator.

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

Performs the + operation.

impl BorshDeserialize for NearToken

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self>

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

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

impl Clone for NearToken

fn clone(&self) -> NearToken

Returns a duplicate 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

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<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for NearToken

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

Formats the value using the given formatter.

impl FromStr for NearToken

type Err = ParseAmountError

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 NearToken

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

fn into_near_token(self) -> Result<NearToken, ParseAmountError>

Convert into a NearToken.

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: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Sub for NearToken

type Output = NearToken

The resulting type after applying the - operator.

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

Performs the - operation.

impl TryFrom<&str> for NearToken

type Error = ParseAmountError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for NearToken

impl Eq for NearToken

impl StructuralPartialEq for NearToken