Enum lightning_invoice::SiPrefix

pub enum SiPrefix {
    Milli,
    Micro,
    Nano,
    Pico,
}

SI prefixes for the human readable part

Variants

Milli

10^-3

Micro

10^-6

Nano

10^-9

Pico

10^-12

Methods

impl SiPrefix

pub fn multiplier(&self) -> u64

Returns the multiplier to go from a BTC value to picoBTC implied by this SiPrefix. This is effectively 10^12 * the prefix multiplier

pub fn values_desc() -> &'static [SiPrefix]

Returns all enum variants of SiPrefix sorted in descending order of their associated multiplier.

Trait Implementations

impl Eq for SiPrefix

impl Copy for SiPrefix

impl PartialEq<SiPrefix> for SiPrefix

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Clone for SiPrefix

fn clone(&self) -> SiPrefix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SiPrefix

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

Formats the value using the given formatter.

impl Display for SiPrefix

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

Formats the value using the given formatter.

impl FromStr for SiPrefix

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(currency_prefix: &str) -> Result<Self, ParseError>

Parses a string s to return a value of this type.