Struct Currency 

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

Represents a Mina currency amount stored internally as nanomina (atomic units).

Examples

use mina_sdk::Currency;

let one_mina = Currency::from_mina("1.5").unwrap();
assert_eq!(one_mina.nanomina(), 1_500_000_000);
assert_eq!(one_mina.mina(), "1.500000000");

Implementations

impl Currency

pub fn from_nanomina(nanomina: u64) -> Self

Create from a nanomina (atomic unit) value.

pub fn from_mina(s: &str) -> Result<Self>

Create from a whole MINA decimal string (e.g. “1.5”, “100”, “0.000000001”).

pub fn from_graphql(s: &str) -> Result<Self>

Create from a GraphQL response value (nanomina as string).

pub fn nanomina(&self) -> u64

Get the value in nanomina (atomic units).

pub fn mina(&self) -> String

Get the value as a MINA decimal string with 9 decimal places.

pub fn to_nanomina_str(&self) -> String

Convert to nanomina string for GraphQL API submission.

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

Checked addition. Returns None on overflow.

pub fn checked_sub(self, rhs: Currency) -> Result<Currency>

Checked subtraction. Returns Err(CurrencyUnderflow) if result would be negative.

pub fn checked_mul(self, rhs: u64) -> Option<Currency>

Multiply by a scalar.

Trait Implementations

impl Add for Currency

type Output = Currency

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Currency

fn clone(&self) -> Currency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Currency

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

Formats the value using the given formatter.

impl Display for Currency

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

Formats the value using the given formatter.

impl Hash for Currency

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 Mul<Currency> for u64

type Output = Currency

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<u64> for Currency

type Output = Currency

The resulting type after applying the * operator.

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

Performs the * operation.

impl Ord for Currency

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

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

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

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

Panics on underflow. Use checked_sub for fallible version.

type Output = Currency

The resulting type after applying the - operator.

impl Copy for Currency

impl Eq for Currency

impl StructuralPartialEq for Currency