pub struct Amount(_);
Expand description
Represent an unsigned quantity of Wownero, internally as Dust.
The Amount
type can be used to express Wownero amounts that supports arithmetic and
conversion to various denominations.
Implementations
sourceimpl Amount
impl Amount
sourcepub fn from_dust(dust: u64) -> Amount
pub fn from_dust(dust: u64) -> Amount
Create an Amount
with Dust precision and the given number of Dust.
sourcepub fn from_wow(wow: f64) -> Result<Amount, ParsingError>
pub fn from_wow(wow: f64) -> Result<Amount, ParsingError>
Convert from a value expressing Wowneros 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_wow(self) -> f64
pub fn as_wow(self) -> f64
Express this Amount
as a floating-point value in Wownero.
Equivalent to to_float_in(Denomination::Wownero)
.
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
sourceimpl AddAssign<Amount> for Amount
impl AddAssign<Amount> for Amount
sourcefn add_assign(&mut self, other: Amount)
fn add_assign(&mut self, other: Amount)
Performs the +=
operation. Read more
sourceimpl DivAssign<u64> for Amount
impl DivAssign<u64> for Amount
sourcefn div_assign(&mut self, rhs: u64)
fn div_assign(&mut self, rhs: u64)
Performs the /=
operation. Read more
sourceimpl MulAssign<u64> for Amount
impl MulAssign<u64> for Amount
sourcefn mul_assign(&mut self, rhs: u64)
fn mul_assign(&mut self, rhs: u64)
Performs the *=
operation. Read more
sourceimpl Ord for Amount
impl Ord for Amount
sourceimpl PartialOrd<Amount> for Amount
impl PartialOrd<Amount> for Amount
sourcefn partial_cmp(&self, other: &Amount) -> Option<Ordering>
fn partial_cmp(&self, other: &Amount) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl RemAssign<u64> for Amount
impl RemAssign<u64> for Amount
sourcefn rem_assign(&mut self, modulus: u64)
fn rem_assign(&mut self, modulus: u64)
Performs the %=
operation. Read more
sourceimpl SerdeAmount for Amount
Available on crate feature serde
only.
impl SerdeAmount for Amount
serde
only.sourcefn ser_dust<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
fn ser_dust<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
Serialize with Serializer
the amount as dustnero.
sourcefn des_dust<'d, D: Deserializer<'d>>(d: D) -> Result<Self, D::Error>
fn des_dust<'d, D: Deserializer<'d>>(d: D) -> Result<Self, D::Error>
Deserialize with Deserializer
an amount in dustnero.
sourcefn ser_wow<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
fn ser_wow<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
Serialize with Serializer
the amount as Wownero.
sourcefn des_wow<'d, D: Deserializer<'d>>(d: D) -> Result<Self, D::Error>
fn des_wow<'d, D: Deserializer<'d>>(d: D) -> Result<Self, D::Error>
Deserialize with Deserializer
an amount in Wownero.
sourceimpl SerdeAmountForOpt for Amount
Available on crate feature serde
only.
impl SerdeAmountForOpt for Amount
serde
only.sourcefn type_prefix() -> &'static str
fn type_prefix() -> &'static str
Return the type prefix (i
or u
) used to sign or not the amount.
sourcefn ser_dust_opt<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
fn ser_dust_opt<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
Serialize with Serializer
an optional amount as dustnero.
sourcefn ser_wow_opt<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
fn ser_wow_opt<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
Serialize with Serializer
an optional amount as Wownero.
sourceimpl SubAssign<Amount> for Amount
impl SubAssign<Amount> for Amount
sourcefn sub_assign(&mut self, other: Amount)
fn sub_assign(&mut self, other: Amount)
Performs the -=
operation. Read more
impl Copy for Amount
impl Eq for Amount
impl StructuralEq for Amount
impl StructuralPartialEq for Amount
Auto Trait Implementations
impl RefUnwindSafe for Amount
impl Send for Amount
impl Sync for Amount
impl Unpin for Amount
impl UnwindSafe for Amount
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more