pub struct Amount(/* private fields */);
Expand description
Amount
The Amount type can be used to express TPC amounts that supports arithmetic and conversion to various denominations.
Warning!
This type implements several arithmetic operations from std::ops.
To prevent errors due to overflow or underflow when using these operations,
it is advised to instead use the checked arithmetic methods whose names
start with checked_
. The operations from std::ops that Amount
implements will panic when overflow or underflow occurs. Also note that
since the internal representation of amounts is unsigned, subtracting below
zero is considered an underflow and will cause a panic if you’re not using
the checked arithmetic methods.
Implementations§
source§impl Amount
impl Amount
sourcepub fn from_tap(tapyrus: u64) -> Amount
pub fn from_tap(tapyrus: u64) -> Amount
Create an Amount with tapyrus precision and the given number of tapyrus.
sourcepub fn from_tpc(tpc: f64) -> Result<Amount, ParseAmountError>
pub fn from_tpc(tpc: f64) -> Result<Amount, ParseAmountError>
Convert from a value expressing tpcs to an Amount.
sourcepub fn from_str_in(
s: &str,
denom: Denomination
) -> Result<Amount, ParseAmountError>
pub fn from_str_in( s: &str, denom: Denomination ) -> Result<Amount, ParseAmountError>
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, ParseAmountError>
pub fn from_str_with_denomination(s: &str) -> Result<Amount, ParseAmountError>
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_tpc(self) -> f64
pub fn as_tpc(self) -> f64
Express this Amount as a floating-point value in TPC.
Equivalent to to_float_in(Denomination::TPC)
.
Please be aware of the risk of using floating-point numbers.
sourcepub fn from_float_in(
value: f64,
denom: Denomination
) -> Result<Amount, ParseAmountError>
pub fn from_float_in( value: f64, denom: Denomination ) -> Result<Amount, ParseAmountError>
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, ParseAmountError>
pub fn to_signed(self) -> Result<SignedAmount, ParseAmountError>
Convert to a signed amount.
Trait Implementations§
source§impl AddAssign for Amount
impl AddAssign 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 for Amount
impl PartialEq for Amount
source§impl PartialOrd for Amount
impl PartialOrd 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 SubAssign for Amount
impl SubAssign for Amount
source§fn sub_assign(&mut self, other: Amount)
fn sub_assign(&mut self, other: Amount)
-=
operation. Read more