Enum bdk_chain::bitcoin::amount::Denomination
#[non_exhaustive]pub enum Denomination {
Bitcoin,
CentiBitcoin,
MilliBitcoin,
MicroBitcoin,
NanoBitcoin,
PicoBitcoin,
Bit,
Satoshi,
MilliSatoshi,
}
Expand description
A set of denominations in which amounts can be expressed.
§Examples
assert_eq!(Amount::from_str("1 BTC").unwrap(), Amount::from_sat(100_000_000));
assert_eq!(Amount::from_str("1 cBTC").unwrap(), Amount::from_sat(1_000_000));
assert_eq!(Amount::from_str("1 mBTC").unwrap(), Amount::from_sat(100_000));
assert_eq!(Amount::from_str("1 uBTC").unwrap(), Amount::from_sat(100));
assert_eq!(Amount::from_str("10 nBTC").unwrap(), Amount::from_sat(1));
assert_eq!(Amount::from_str("10000 pBTC").unwrap(), Amount::from_sat(1));
assert_eq!(Amount::from_str("1 bit").unwrap(), Amount::from_sat(100));
assert_eq!(Amount::from_str("1 sat").unwrap(), Amount::from_sat(1));
assert_eq!(Amount::from_str("1000 msats").unwrap(), Amount::from_sat(1));
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
Bitcoin
BTC
CentiBitcoin
cBTC
MilliBitcoin
mBTC
MicroBitcoin
uBTC
NanoBitcoin
nBTC
PicoBitcoin
pBTC
Bit
bits
Satoshi
satoshi
MilliSatoshi
msat
Implementations§
§impl Denomination
impl Denomination
pub const BTC: Denomination = Denomination::Bitcoin
pub const BTC: Denomination = Denomination::Bitcoin
Convenience alias for Denomination::Bitcoin
.
pub const SAT: Denomination = Denomination::Satoshi
pub const SAT: Denomination = Denomination::Satoshi
Convenience alias for Denomination::Satoshi
.
Trait Implementations§
§impl Clone for Denomination
impl Clone for Denomination
§fn clone(&self) -> Denomination
fn clone(&self) -> Denomination
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read more§impl Debug for Denomination
impl Debug for Denomination
§impl Display for Denomination
impl Display for Denomination
§impl FromStr for Denomination
impl FromStr for Denomination
§fn from_str(s: &str) -> Result<Denomination, <Denomination as FromStr>::Err>
fn from_str(s: &str) -> Result<Denomination, <Denomination as FromStr>::Err>
Convert from a str to Denomination.
Any combination of upper and/or lower case, excluding uppercase of SI(m, u, n, p) is considered valid.
- Singular: BTC, mBTC, uBTC, nBTC, pBTC
- Plural or singular: sat, satoshi, bit, msat
Due to ambiguity between mega and milli, pico and peta we prohibit usage of leading capital ‘M’, ‘P’.
§impl Hash for Denomination
impl Hash for Denomination
§impl PartialEq for Denomination
impl PartialEq for Denomination
§fn eq(&self, other: &Denomination) -> bool
fn eq(&self, other: &Denomination) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl Copy for Denomination
impl Eq for Denomination
impl StructuralPartialEq for Denomination
Auto Trait Implementations§
impl Freeze for Denomination
impl RefUnwindSafe for Denomination
impl Send for Denomination
impl Sync for Denomination
impl Unpin for Denomination
impl UnwindSafe for Denomination
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
Mutably borrows from an owned value. Read more
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key. Read more