Struct Amount 

pub struct Amount { /* private fields */ }

A monetary amount, stored internally in Rials.

Construct with Amount::toman or Amount::rial. The gateway drivers use Amount::as_rials to send the request body, so accidental unit mix-ups are impossible.

use iran_pay::Amount;

let price = Amount::toman(50_000);
assert_eq!(price.as_rials(),  500_000);
assert_eq!(price.as_tomans(), 50_000);

Implementations

impl Amount

pub const fn toman(value: i64) -> Self

Construct from a Toman amount (multiplied by 10 internally).

pub const fn rial(value: i64) -> Self

Construct from a Rial amount.

pub const fn new(value: i64, currency: Currency) -> Self

Construct from a value paired with a Currency.

pub const fn as_rials(&self) -> i64

The amount expressed in Rials (always exact).

pub const fn as_tomans(&self) -> i64

The amount expressed in Tomans (truncated toward zero if not divisible by 10 — but Iranian gateways always operate on multiples of 10 Rials, so in practice this is exact).

pub const fn is_zero(&self) -> bool

Returns true if the amount is exactly zero Rials.

Trait Implementations

impl Clone for Amount

fn clone(&self) -> Amount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Amount

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Amount

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Amount

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

123,000 Rial (with thousand separators).

impl Ord for Amount

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Amount

impl Eq for Amount

impl StructuralPartialEq for Amount