Enum bitcoin::util::amount::Denomination

pub enum Denomination {
    Bitcoin,
    MilliBitcoin,
    MicroBitcoin,
    NanoBitcoin,
    PicoBitcoin,
    Bit,
    Satoshi,
    MilliSatoshi,
}

A set of denominations in which amounts can be expressed.

Variants

Bitcoin

BTC

MilliBitcoin

mBTC

MicroBitcoin

uBTC

NanoBitcoin

nBTC

PicoBitcoin

pBTC

Bit

bits

Satoshi

satoshi

MilliSatoshi

msat

Trait Implementations

impl Clone for Denomination

fn clone(&self) -> Denomination

Returns a copy of the value.

const 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>

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’.

type Err = ParseAmountError

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<Denomination> for Denomination

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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 StructuralEq for Denomination

impl StructuralPartialEq for Denomination