pub struct Amount(_);
Expand description
Represent an unsigned quantity of Monero, internally as piconero.
The Amount
type can be used to express Monero amounts that supports arithmetic and
conversion to various denominations.
Implementations§
source§impl Amount
impl Amount
sourcepub fn from_pico(piconero: u64) -> Amount
pub fn from_pico(piconero: u64) -> Amount
Create an Amount
with piconero precision and the given number of piconero.
sourcepub fn from_xmr(xmr: f64) -> Result<Amount, ParsingError>
pub fn from_xmr(xmr: f64) -> Result<Amount, ParsingError>
Convert from a value expressing moneros to an Amount
.
sourcepub fn from_str_in(s: &str, denom: Denomination) -> Result<Amount, ParsingError>
pub fn from_str_in(s: &str, denom: Denomination) -> Result<Amount, ParsingError>
Parse a decimal string as a value in the given denomination.
Note: This only parses the value string. If you want to parse a value with denomination,
use FromStr
.
sourcepub fn from_str_with_denomination(s: &str) -> Result<Amount, ParsingError>
pub fn from_str_with_denomination(s: &str) -> Result<Amount, ParsingError>
Parses amounts with denomination suffix like they are produced with
to_string_with_denomination
or with fmt::Display
. If you want to parse only the
amount without the denomination, use from_str_in
.
sourcepub fn to_float_in(self, denom: Denomination) -> f64
pub fn to_float_in(self, denom: Denomination) -> f64
Express this Amount
as a floating-point value in the given denomination.
Please be aware of the risk of using floating-point numbers.
sourcepub fn as_xmr(self) -> f64
pub fn as_xmr(self) -> f64
Express this Amount
as a floating-point value in Monero.
Equivalent to to_float_in(Denomination::Monero)
.
Please be aware of the risk of using floating-point numbers.
sourcepub fn from_float_in(
value: f64,
denom: Denomination
) -> Result<Amount, ParsingError>
pub fn from_float_in(
value: f64,
denom: Denomination
) -> Result<Amount, ParsingError>
Convert this Amount
in floating-point notation with a given denomination. Can return
error if the amount is too big, too precise or negative.
Please be aware of the risk of using floating-point numbers.
sourcepub fn fmt_value_in(self, f: &mut dyn Write, denom: Denomination) -> Result
pub fn fmt_value_in(self, f: &mut dyn Write, denom: Denomination) -> Result
Format the value of this Amount
in the given denomination.
Does not include the denomination.
sourcepub fn to_string_in(self, denom: Denomination) -> String
pub fn to_string_in(self, denom: Denomination) -> String
Get a string number of this Amount
in the given denomination.
Does not include the denomination.
sourcepub fn to_string_with_denomination(self, denom: Denomination) -> String
pub fn to_string_with_denomination(self, denom: Denomination) -> String
Get a formatted string of this Amount
in the given denomination, suffixed with the
abbreviation for the denomination.
sourcepub fn checked_add(self, rhs: Amount) -> Option<Amount>
pub fn checked_add(self, rhs: Amount) -> Option<Amount>
Checked addition.
Returns None
if overflow occurred.
sourcepub fn checked_sub(self, rhs: Amount) -> Option<Amount>
pub fn checked_sub(self, rhs: Amount) -> Option<Amount>
Checked subtraction.
Returns None
if overflow occurred.
sourcepub fn checked_mul(self, rhs: u64) -> Option<Amount>
pub fn checked_mul(self, rhs: u64) -> Option<Amount>
Checked multiplication.
Returns None
if overflow occurred.
sourcepub fn checked_div(self, rhs: u64) -> Option<Amount>
pub fn checked_div(self, rhs: u64) -> Option<Amount>
Checked integer division.
Be aware that integer division loses the remainder if no exact division
can be made.
Returns None
if overflow occurred.
sourcepub fn checked_rem(self, rhs: u64) -> Option<Amount>
pub fn checked_rem(self, rhs: u64) -> Option<Amount>
Checked remainder.
Returns None
if overflow occurred.
sourcepub fn to_signed(self) -> Result<SignedAmount, ParsingError>
pub fn to_signed(self) -> Result<SignedAmount, ParsingError>
Convert to a signed amount.
Trait Implementations§
source§impl AddAssign<Amount> for Amount
impl AddAssign<Amount> for Amount
source§fn add_assign(&mut self, other: Amount)
fn add_assign(&mut self, other: Amount)
+=
operation. Read moresource§impl DivAssign<u64> for Amount
impl DivAssign<u64> for Amount
source§fn div_assign(&mut self, rhs: u64)
fn div_assign(&mut self, rhs: u64)
/=
operation. Read moresource§impl MulAssign<u64> for Amount
impl MulAssign<u64> for Amount
source§fn mul_assign(&mut self, rhs: u64)
fn mul_assign(&mut self, rhs: u64)
*=
operation. Read moresource§impl Ord for Amount
impl Ord for Amount
source§impl PartialEq<Amount> for Amount
impl PartialEq<Amount> for Amount
source§impl PartialOrd<Amount> for Amount
impl PartialOrd<Amount> for Amount
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl RemAssign<u64> for Amount
impl RemAssign<u64> for Amount
source§fn rem_assign(&mut self, modulus: u64)
fn rem_assign(&mut self, modulus: u64)
%=
operation. Read moresource§impl SerdeAmount for Amount
Available on crate feature serde
only.
impl SerdeAmount for Amount
serde
only.source§fn ser_pico<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
fn ser_pico<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
Serializer
the amount as piconero.source§fn des_pico<'d, D: Deserializer<'d>>(d: D) -> Result<Self, D::Error>
fn des_pico<'d, D: Deserializer<'d>>(d: D) -> Result<Self, D::Error>
Deserializer
an amount in piconero.source§fn ser_xmr<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
fn ser_xmr<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
Serializer
the amount as monero.source§fn des_xmr<'d, D: Deserializer<'d>>(d: D) -> Result<Self, D::Error>
fn des_xmr<'d, D: Deserializer<'d>>(d: D) -> Result<Self, D::Error>
Deserializer
an amount in monero.source§impl SerdeAmountForOpt for Amount
Available on crate feature serde
only.
impl SerdeAmountForOpt for Amount
serde
only.source§fn type_prefix() -> &'static str
fn type_prefix() -> &'static str
i
or u
) used to sign or not the amount.source§fn ser_pico_opt<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
fn ser_pico_opt<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
Serializer
an optional amount as piconero.source§fn ser_xmr_opt<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
fn ser_xmr_opt<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
Serializer
an optional amount as monero.source§impl SerdeAmountForSlice for Amount
Available on crate feature serde
only.
impl SerdeAmountForSlice for Amount
serde
only.source§fn type_prefix() -> &'static str
fn type_prefix() -> &'static str
i
or u
) used to sign or not the amount.source§fn ser_pico_slice<S: SerializeSeq>(&self, s: &mut S) -> Result<(), S::Error>
fn ser_pico_slice<S: SerializeSeq>(&self, s: &mut S) -> Result<(), S::Error>
Serializer
a slice of amounts as a slice of piconeros.source§fn ser_xmr_slice<S: SerializeSeq>(&self, s: &mut S) -> Result<(), S::Error>
fn ser_xmr_slice<S: SerializeSeq>(&self, s: &mut S) -> Result<(), S::Error>
Serializer
a slice of amounts as a slice of moneros.source§impl SubAssign<Amount> for Amount
impl SubAssign<Amount> for Amount
source§fn sub_assign(&mut self, other: Amount)
fn sub_assign(&mut self, other: Amount)
-=
operation. Read more