Enum Denomination

#[non_exhaustive]
pub enum Denomination {
    Bitcoin,
    CentiBitcoin,
    MilliBitcoin,
    MicroBitcoin,
    Bit,
    Satoshi,
}

A set of denominations in which amounts can be expressed.

Accepted Denominations

All upper or lower case, excluding SI prefix (c, m, u) which must be lower case.

• Singular: BTC, cBTC, mBTC, uBTC
• Plural or singular: sat, satoshi, bit

Note

Due to ambiguity between mega and milli we prohibit usage of leading capital ‘M’. It is more important to protect users from incorrectly using a capital M to mean milli than to allow Megabitcoin which is not a realistic denomination, and Megasatoshi which is equivalent to cBTC which is allowed.

Examples

assert_eq!("1 BTC".parse::<Amount>().unwrap(), Amount::from_sat(100_000_000));
assert_eq!("1 cBTC".parse::<Amount>().unwrap(), Amount::from_sat(1_000_000));
assert_eq!("1 mBTC".parse::<Amount>().unwrap(), Amount::from_sat(100_000));
assert_eq!("1 uBTC".parse::<Amount>().unwrap(), Amount::from_sat(100));
assert_eq!("1 bit".parse::<Amount>().unwrap(), Amount::from_sat(100));
assert_eq!("1 sat".parse::<Amount>().unwrap(), Amount::from_sat(1));

Variants (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

Bit

bits

Satoshi

satoshi

Implementations

impl Denomination

pub const BTC: Self = Denomination::Bitcoin

Convenience alias for Denomination::Bitcoin.

pub const SAT: Self = Denomination::Satoshi

Convenience alias for Denomination::Satoshi.

Trait Implementations

impl Clone for Denomination

fn clone(&self) -> Denomination

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Denomination

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Denomination

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromStr for Denomination

fn from_str(s: &str) -> Result<Self, Self::Err>

Converts from a str to a Denomination.

Errors

• If the denomination begins with a capital M a PossiblyConfusingDenominationError is returned.

• If an unknown denomination is used, an UnknownDenominationError is returned.

type Err = ParseDenominationError

The associated error which can be returned from parsing.

impl Hash for Denomination

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Denomination

fn eq(&self, other: &Denomination) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Denomination

impl Eq for Denomination

impl StructuralPartialEq for Denomination