pub struct Amount(/* private fields */);
Expand description
Amount
The Amount type can be used to express Bitcoin amounts that support 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§
§impl Amount
impl Amount
pub const SIZE: usize = 8usize
pub const SIZE: usize = 8usize
The number of bytes that an amount contributes to the size of a transaction.
pub const fn from_sat(satoshi: u64) -> Amount
pub const fn from_sat(satoshi: u64) -> Amount
Create an Amount with satoshi precision and the given number of satoshis.
pub 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.
pub const fn from_int_btc(btc: u64) -> Amount
pub const fn from_int_btc(btc: u64) -> Amount
pub 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.
pub fn from_str_with_denomination(s: &str) -> Result<Amount, ParseError>
pub fn from_str_with_denomination(s: &str) -> Result<Amount, ParseError>
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.
pub 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.
pub 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.
pub fn display_in(self, denomination: Denomination) -> Display
pub fn display_in(self, denomination: Denomination) -> Display
Create an object that implements fmt::Display
using specified denomination.
pub fn display_dynamic(self) -> Display
pub fn display_dynamic(self) -> Display
Create an object that implements fmt::Display
dynamically selecting denomination.
This will use BTC for values greater than or equal to 1 BTC and satoshis otherwise. To avoid confusion the denomination is always shown.
pub fn fmt_value_in(
self,
f: &mut dyn Write,
denom: Denomination
) -> Result<(), Error>
pub fn fmt_value_in( self, f: &mut dyn Write, denom: Denomination ) -> Result<(), Error>
Format the value of this Amount in the given denomination.
Does not include the denomination.
pub 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.
pub 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.
pub fn checked_add(self, rhs: Amount) -> Option<Amount>
pub fn checked_add(self, rhs: Amount) -> Option<Amount>
Checked addition.
Returns None if overflow occurred.
pub fn checked_sub(self, rhs: Amount) -> Option<Amount>
pub fn checked_sub(self, rhs: Amount) -> Option<Amount>
Checked subtraction.
Returns None if overflow occurred.
pub fn checked_mul(self, rhs: u64) -> Option<Amount>
pub fn checked_mul(self, rhs: u64) -> Option<Amount>
Checked multiplication.
Returns None if overflow occurred.
pub 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.
pub fn checked_rem(self, rhs: u64) -> Option<Amount>
pub fn checked_rem(self, rhs: u64) -> Option<Amount>
Checked remainder.
Returns None if overflow occurred.
pub fn unchecked_add(self, rhs: Amount) -> Amount
pub fn unchecked_add(self, rhs: Amount) -> Amount
Unchecked addition.
Computes self + rhs
. Panics in debug mode, wraps in release mode.
pub fn unchecked_sub(self, rhs: Amount) -> Amount
pub fn unchecked_sub(self, rhs: Amount) -> Amount
Unchecked subtraction.
Computes self - rhs
. Panics in debug mode, wraps in release mode.
pub fn to_signed(self) -> Result<SignedAmount, OutOfRangeError>
pub fn to_signed(self) -> Result<SignedAmount, OutOfRangeError>
Convert to a signed amount.
Trait Implementations§
§impl AddAssign for Amount
impl AddAssign for Amount
§fn add_assign(&mut self, other: Amount)
fn add_assign(&mut self, other: Amount)
+=
operation. Read more§impl<'de> Deserialize<'de> for Amount
impl<'de> Deserialize<'de> for Amount
§fn deserialize<__D>(
__deserializer: __D
) -> Result<Amount, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D
) -> Result<Amount, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
§impl DivAssign<u64> for Amount
impl DivAssign<u64> for Amount
§fn div_assign(&mut self, rhs: u64)
fn div_assign(&mut self, rhs: u64)
/=
operation. Read more§impl MulAssign<u64> for Amount
impl MulAssign<u64> for Amount
§fn mul_assign(&mut self, rhs: u64)
fn mul_assign(&mut self, rhs: u64)
*=
operation. Read more§impl Ord for Amount
impl Ord for Amount
§impl PartialOrd for Amount
impl PartialOrd for Amount
§fn partial_cmp(&self, other: &Amount) -> Option<Ordering>
fn partial_cmp(&self, other: &Amount) -> Option<Ordering>
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 more§impl RemAssign<u64> for Amount
impl RemAssign<u64> for Amount
§fn rem_assign(&mut self, modulus: u64)
fn rem_assign(&mut self, modulus: u64)
%=
operation. Read more§impl SerdeAmount for Amount
impl SerdeAmount for Amount
fn ser_sat<S>(
self,
s: S,
_: Token
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn des_sat<'d, D>(
d: D,
_: Token
) -> Result<Amount, <D as Deserializer<'d>>::Error>where
D: Deserializer<'d>,
fn ser_btc<S>(
self,
s: S,
_: Token
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn des_btc<'d, D>(
d: D,
_: Token
) -> Result<Amount, <D as Deserializer<'d>>::Error>where
D: Deserializer<'d>,
§impl SerdeAmountForOpt for Amount
impl SerdeAmountForOpt for Amount
fn type_prefix(_: Token) -> &'static str
fn ser_sat_opt<S>(
self,
s: S,
_: Token
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn ser_btc_opt<S>(
self,
s: S,
_: Token
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
§impl Serialize for Amount
impl Serialize for Amount
§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
§impl SubAssign for Amount
impl SubAssign for Amount
§fn sub_assign(&mut self, other: Amount)
fn sub_assign(&mut self, other: Amount)
-=
operation. Read more§impl TryFrom<Amount> for SignedAmount
impl TryFrom<Amount> for SignedAmount
§impl TryFrom<SignedAmount> for Amount
impl TryFrom<SignedAmount> for Amount
impl Copy for Amount
impl Eq for Amount
impl StructuralPartialEq for Amount
Auto Trait Implementations§
impl Freeze for Amount
impl RefUnwindSafe for Amount
impl Send for Amount
impl Sync for Amount
impl Unpin for Amount
impl UnwindSafe for Amount
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> CheckedSum<Amount> for T
impl<T> CheckedSum<Amount> for T
§fn checked_sum(self) -> Option<Amount>
fn checked_sum(self) -> Option<Amount>
None
.