Enum 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

Implementations

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.

This is not exported to bindings users as we don’t yet support a slice of enums, and also because this function isn’t the most critical to expose.

Trait Implementations

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<(), Error>

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 = Bolt11ParseError

The associated error which can be returned from parsing.

fn from_str(currency_prefix: &str) -> Result<SiPrefix, Bolt11ParseError>

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

impl Hash for SiPrefix

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

where __H: Hasher,

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 Ord for SiPrefix

fn cmp(&self, other: &SiPrefix) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SiPrefix

fn eq(&self, other: &SiPrefix) -> 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 PartialOrd for SiPrefix

fn partial_cmp(&self, other: &SiPrefix) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SiPrefix

impl Eq for SiPrefix

impl StructuralPartialEq for SiPrefix