pub struct Amount(_);
Expand description
Amount
The Amount type can be used to express Bitcoin amounts that supports arithmetic and conversion to various denominations.
Warning!
This type implements several arithmetic operations from core::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 core::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
sourceimpl Amount
impl Amount
sourcepub const MAX_MONEY: Amount = Amount(21_000_000 * 100_000_000)
pub const MAX_MONEY: Amount = Amount(21_000_000 * 100_000_000)
The maximum value allowed as an amount. Useful for sanity checking.
sourcepub fn from_sat(satoshi: u64) -> Amount
pub fn from_sat(satoshi: u64) -> Amount
Create an Amount with satoshi precision and the given number of satoshis.
sourcepub fn from_btc(btc: f64) -> Result<Amount, ParseAmountError>
pub fn from_btc(btc: f64) -> Result<Amount, ParseAmountError>
Convert from a value expressing bitcoins 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 Self::to_string_with_denomination or with fmt::Display. If you want to parse only the amount without the denomination, use Self::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_btc(self) -> f64
pub fn as_btc(self) -> f64
Express this Amount as a floating-point value in Bitcoin.
Equivalent to to_float_in(Denomination::Bitcoin)
.
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
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.sourceimpl SerdeAmountForOpt for Amount
Available on crate feature serde
only.
impl SerdeAmountForOpt for Amount
serde
only.fn type_prefix() -> &'static str
fn ser_sat_opt<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
fn ser_btc_opt<S: Serializer>(self, s: S) -> Result<S::Ok, S::Error>
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
sourceimpl<T> CheckedSum<Amount> for T where
T: Iterator<Item = Amount>,
impl<T> CheckedSum<Amount> for T where
T: Iterator<Item = Amount>,
sourcefn checked_sum(self) -> Option<Amount>
fn checked_sum(self) -> Option<Amount>
Calculate the sum over the iterator using checked arithmetic. If an over or underflow would
happen it returns None
. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more