pub struct SignedAmount(_);
Expand description
Represent an signed quantity of Wownero, internally as signed Wownero.
The SignedAmount
type can be used to express Wownero amounts that supports arithmetic and
conversion to various denominations.
Implementations
sourceimpl SignedAmount
impl SignedAmount
sourcepub const ZERO: SignedAmount = SignedAmount(0)
pub const ZERO: SignedAmount = SignedAmount(0)
The zero amount.
sourcepub const ONE_DUST: SignedAmount = SignedAmount(1)
pub const ONE_DUST: SignedAmount = SignedAmount(1)
Exactly one Dust.
sourcepub const ONE_WOW: SignedAmount = SignedAmount(100_000_000_000)
pub const ONE_WOW: SignedAmount = SignedAmount(100_000_000_000)
Exactly one Wownero.
sourcepub fn from_dust(dust: i64) -> SignedAmount
pub fn from_dust(dust: i64) -> SignedAmount
Create an SignedAmount
with Dust precision and the given number of Dusts.
sourcepub fn as_dust(self) -> i64
pub fn as_dust(self) -> i64
Get the number of Dusts in this SignedAmount
.
sourcepub fn max_value() -> SignedAmount
pub fn max_value() -> SignedAmount
The maximum value of an SignedAmount
.
sourcepub fn min_value() -> SignedAmount
pub fn min_value() -> SignedAmount
The minimum value of an SignedAmount
.
sourcepub fn from_wow(wow: f64) -> Result<SignedAmount, ParsingError>
pub fn from_wow(wow: f64) -> Result<SignedAmount, ParsingError>
Convert from a value expressing Wowneros to an SignedAmount
.
sourcepub fn from_str_in(
s: &str,
denom: Denomination
) -> Result<SignedAmount, ParsingError>
pub fn from_str_in(
s: &str,
denom: Denomination
) -> Result<SignedAmount, 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<SignedAmount, ParsingError>
pub fn from_str_with_denomination(s: &str) -> Result<SignedAmount, 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 SignedAmount
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 SignedAmount
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<SignedAmount, ParsingError>
pub fn from_float_in(
value: f64,
denom: Denomination
) -> Result<SignedAmount, ParsingError>
Convert this SignedAmount
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 SignedAmount
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 SignedAmount
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 SignedAmount
in the given denomination, suffixed with
the abbreviation for the denomination.
sourcepub fn abs(self) -> SignedAmount
pub fn abs(self) -> SignedAmount
Get the absolute value of this SignedAmount
.
sourcepub fn signum(self) -> i64
pub fn signum(self) -> i64
Returns a number representing sign of this SignedAmount
.
0
if the amount is zero1
if the amount is positive-1
if the amount is negative
sourcepub fn is_positive(self) -> bool
pub fn is_positive(self) -> bool
Returns true
if this SignedAmount
is positive and false
if this SignedAmount
is
zero or negative.
sourcepub fn is_negative(self) -> bool
pub fn is_negative(self) -> bool
Returns true
if this SignedAmount
is negative and false
if this SignedAmount
is
zero or positive.
sourcepub fn checked_abs(self) -> Option<SignedAmount>
pub fn checked_abs(self) -> Option<SignedAmount>
Get the absolute value of this SignedAmount
. Returns None
if overflow occurred.
(self == min_value()
)
sourcepub fn checked_add(self, rhs: SignedAmount) -> Option<SignedAmount>
pub fn checked_add(self, rhs: SignedAmount) -> Option<SignedAmount>
Checked addition.
Returns None
if overflow occurred.
sourcepub fn checked_sub(self, rhs: SignedAmount) -> Option<SignedAmount>
pub fn checked_sub(self, rhs: SignedAmount) -> Option<SignedAmount>
Checked subtraction.
Returns None
if overflow occurred.
sourcepub fn checked_mul(self, rhs: i64) -> Option<SignedAmount>
pub fn checked_mul(self, rhs: i64) -> Option<SignedAmount>
Checked multiplication.
Returns None
if overflow occurred.
sourcepub fn checked_div(self, rhs: i64) -> Option<SignedAmount>
pub fn checked_div(self, rhs: i64) -> Option<SignedAmount>
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: i64) -> Option<SignedAmount>
pub fn checked_rem(self, rhs: i64) -> Option<SignedAmount>
Checked remainder.
Returns None
if overflow occurred.
sourcepub fn positive_sub(self, rhs: SignedAmount) -> Option<SignedAmount>
pub fn positive_sub(self, rhs: SignedAmount) -> Option<SignedAmount>
Subtraction that doesn’t allow negative SignedAmount
s.
Returns None
if either self
, rhs
or the result is strictly negative.
sourcepub fn to_unsigned(self) -> Result<Amount, ParsingError>
pub fn to_unsigned(self) -> Result<Amount, ParsingError>
Convert to an unsigned amount.
Trait Implementations
sourceimpl Add<SignedAmount> for SignedAmount
impl Add<SignedAmount> for SignedAmount
type Output = SignedAmount
type Output = SignedAmount
The resulting type after applying the +
operator.
sourcefn add(self, rhs: SignedAmount) -> Self::Output
fn add(self, rhs: SignedAmount) -> Self::Output
Performs the +
operation. Read more
sourceimpl AddAssign<SignedAmount> for SignedAmount
impl AddAssign<SignedAmount> for SignedAmount
sourcefn add_assign(&mut self, other: SignedAmount)
fn add_assign(&mut self, other: SignedAmount)
Performs the +=
operation. Read more
sourceimpl Clone for SignedAmount
impl Clone for SignedAmount
sourcefn clone(&self) -> SignedAmount
fn clone(&self) -> SignedAmount
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for SignedAmount
impl Debug for SignedAmount
sourceimpl Default for SignedAmount
impl Default for SignedAmount
sourceimpl Display for SignedAmount
impl Display for SignedAmount
sourceimpl Div<i64> for SignedAmount
impl Div<i64> for SignedAmount
sourceimpl DivAssign<i64> for SignedAmount
impl DivAssign<i64> for SignedAmount
sourcefn div_assign(&mut self, rhs: i64)
fn div_assign(&mut self, rhs: i64)
Performs the /=
operation. Read more
sourceimpl FromStr for SignedAmount
impl FromStr for SignedAmount
sourceimpl Hash for SignedAmount
impl Hash for SignedAmount
sourceimpl Mul<i64> for SignedAmount
impl Mul<i64> for SignedAmount
sourceimpl MulAssign<i64> for SignedAmount
impl MulAssign<i64> for SignedAmount
sourcefn mul_assign(&mut self, rhs: i64)
fn mul_assign(&mut self, rhs: i64)
Performs the *=
operation. Read more
sourceimpl Ord for SignedAmount
impl Ord for SignedAmount
sourceimpl PartialEq<SignedAmount> for SignedAmount
impl PartialEq<SignedAmount> for SignedAmount
sourcefn eq(&self, other: &SignedAmount) -> bool
fn eq(&self, other: &SignedAmount) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &SignedAmount) -> bool
fn ne(&self, other: &SignedAmount) -> bool
This method tests for !=
.
sourceimpl PartialOrd<SignedAmount> for SignedAmount
impl PartialOrd<SignedAmount> for SignedAmount
sourcefn partial_cmp(&self, other: &SignedAmount) -> Option<Ordering>
fn partial_cmp(&self, other: &SignedAmount) -> 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 Rem<i64> for SignedAmount
impl Rem<i64> for SignedAmount
sourceimpl RemAssign<i64> for SignedAmount
impl RemAssign<i64> for SignedAmount
sourcefn rem_assign(&mut self, modulus: i64)
fn rem_assign(&mut self, modulus: i64)
Performs the %=
operation. Read more
sourceimpl SerdeAmount for SignedAmount
Available on crate feature serde
only.
impl SerdeAmount for SignedAmount
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 SignedAmount
Available on crate feature serde
only.
impl SerdeAmountForOpt for SignedAmount
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 Sub<SignedAmount> for SignedAmount
impl Sub<SignedAmount> for SignedAmount
type Output = SignedAmount
type Output = SignedAmount
The resulting type after applying the -
operator.
sourcefn sub(self, rhs: SignedAmount) -> Self::Output
fn sub(self, rhs: SignedAmount) -> Self::Output
Performs the -
operation. Read more
sourceimpl SubAssign<SignedAmount> for SignedAmount
impl SubAssign<SignedAmount> for SignedAmount
sourcefn sub_assign(&mut self, other: SignedAmount)
fn sub_assign(&mut self, other: SignedAmount)
Performs the -=
operation. Read more
impl Copy for SignedAmount
impl Eq for SignedAmount
impl StructuralEq for SignedAmount
impl StructuralPartialEq for SignedAmount
Auto Trait Implementations
impl RefUnwindSafe for SignedAmount
impl Send for SignedAmount
impl Sync for SignedAmount
impl Unpin for SignedAmount
impl UnwindSafe for SignedAmount
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