Struct monero::util::amount::Amount [−][src]
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
impl Amount
[src]
impl Amount
[src]pub fn from_pico(piconero: u64) -> Amount
[src]
pub fn from_pico(piconero: u64) -> Amount
[src]Create an Amount
with piconero precision and the given number of piconero.
pub fn from_xmr(xmr: f64) -> Result<Amount, ParsingError>
[src]
pub fn from_xmr(xmr: f64) -> Result<Amount, ParsingError>
[src]Convert from a value expressing moneros to an Amount
.
pub fn from_str_in(s: &str, denom: Denomination) -> Result<Amount, ParsingError>
[src]
pub fn from_str_in(s: &str, denom: Denomination) -> Result<Amount, ParsingError>
[src]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
.
pub fn from_str_with_denomination(s: &str) -> Result<Amount, ParsingError>
[src]
pub fn from_str_with_denomination(s: &str) -> Result<Amount, ParsingError>
[src]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
.
pub fn to_float_in(self, denom: Denomination) -> f64
[src]
pub fn to_float_in(self, denom: Denomination) -> f64
[src]Express this Amount
as a floating-point value in the given denomination.
Please be aware of the risk of using floating-point numbers.
pub fn as_xmr(self) -> f64
[src]
pub fn as_xmr(self) -> f64
[src]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.
pub fn from_float_in(
value: f64,
denom: Denomination
) -> Result<Amount, ParsingError>
[src]
pub fn from_float_in(
value: f64,
denom: Denomination
) -> Result<Amount, ParsingError>
[src]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.
pub fn fmt_value_in(self, f: &mut dyn Write, denom: Denomination) -> Result
[src]
pub fn fmt_value_in(self, f: &mut dyn Write, denom: Denomination) -> Result
[src]Format the value of this Amount
in the given denomination.
Does not include the denomination.
pub fn to_string_in(self, denom: Denomination) -> String
[src]
pub fn to_string_in(self, denom: Denomination) -> String
[src]Get a string number of this Amount
in the given denomination.
Does not include the denomination.
pub fn to_string_with_denomination(self, denom: Denomination) -> String
[src]
pub fn to_string_with_denomination(self, denom: Denomination) -> String
[src]Get a formatted string of this Amount
in the given denomination, suffixed with the
abbreviation for the denomination.
pub fn checked_add(self, rhs: Amount) -> Option<Amount>
[src]
pub fn checked_add(self, rhs: Amount) -> Option<Amount>
[src]Checked addition.
Returns None
if overflow occurred.
pub fn checked_sub(self, rhs: Amount) -> Option<Amount>
[src]
pub fn checked_sub(self, rhs: Amount) -> Option<Amount>
[src]Checked subtraction.
Returns None
if overflow occurred.
pub fn checked_mul(self, rhs: u64) -> Option<Amount>
[src]
pub fn checked_mul(self, rhs: u64) -> Option<Amount>
[src]Checked multiplication.
Returns None
if overflow occurred.
pub fn checked_div(self, rhs: u64) -> Option<Amount>
[src]
pub fn checked_div(self, rhs: u64) -> Option<Amount>
[src]Checked integer division.
Be aware that integer division loses the remainder if no exact division
can be made.
Returns None
if overflow occurred.
pub fn checked_rem(self, rhs: u64) -> Option<Amount>
[src]
pub fn checked_rem(self, rhs: u64) -> Option<Amount>
[src]Checked remainder.
Returns None
if overflow occurred.
pub fn to_signed(self) -> Result<SignedAmount, ParsingError>
[src]
pub fn to_signed(self) -> Result<SignedAmount, ParsingError>
[src]Convert to a signed amount.
Trait Implementations
impl AddAssign<Amount> for Amount
[src]
impl AddAssign<Amount> for Amount
[src]fn add_assign(&mut self, other: Amount)
[src]
fn add_assign(&mut self, other: Amount)
[src]Performs the +=
operation. Read more
impl DivAssign<u64> for Amount
[src]
impl DivAssign<u64> for Amount
[src]fn div_assign(&mut self, rhs: u64)
[src]
fn div_assign(&mut self, rhs: u64)
[src]Performs the /=
operation. Read more
impl MulAssign<u64> for Amount
[src]
impl MulAssign<u64> for Amount
[src]fn mul_assign(&mut self, rhs: u64)
[src]
fn mul_assign(&mut self, rhs: u64)
[src]Performs the *=
operation. Read more
impl Ord for Amount
[src]
impl Ord for Amount
[src]impl PartialOrd<Amount> for Amount
[src]
impl PartialOrd<Amount> for Amount
[src]fn partial_cmp(&self, other: &Amount) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &Amount) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl RemAssign<u64> for Amount
[src]
impl RemAssign<u64> for Amount
[src]fn rem_assign(&mut self, modulus: u64)
[src]
fn rem_assign(&mut self, modulus: u64)
[src]Performs the %=
operation. Read more
impl SubAssign<Amount> for Amount
[src]
impl SubAssign<Amount> for Amount
[src]fn sub_assign(&mut self, other: Amount)
[src]
fn sub_assign(&mut self, other: Amount)
[src]Performs the -=
operation. Read more
impl Copy for Amount
[src]
impl Eq for Amount
[src]
impl StructuralEq for Amount
[src]
impl StructuralPartialEq for Amount
[src]
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
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T, Rhs> NumAssignOps<Rhs> for T where
T: AddAssign<Rhs> + SubAssign<Rhs> + MulAssign<Rhs> + DivAssign<Rhs> + RemAssign<Rhs>,
[src]
T: AddAssign<Rhs> + SubAssign<Rhs> + MulAssign<Rhs> + DivAssign<Rhs> + RemAssign<Rhs>,