Struct Amount 

pub struct Amount(/* private fields */);

An amount of Bitcoin

Sadly, because lightning uses “milli-satoshis” we cannot directly use rust-bitcoin’s Amount type.

In general, when displaying amounts to the user, you should use Self::sats_rounding_up.

Implementations

impl Amount

pub const MAX: Amount

The maximum possible Amount, equal to 21 million BTC

pub const ZERO: Amount

Zero milli-satoshis

pub const fn milli_sats(&self) -> u64

The amount in milli-satoshis

pub const fn sats(&self) -> Result<u64, ()>

The amount in satoshis, if it is exactly a whole number of sats.

pub const fn sats_rounding_up(&self) -> u64

The amount in satoshis, rounding up to the next whole satoshi.

pub const fn from_milli_sats(msats: u64) -> Result<Self, ()>

Constructs a new Amount for the given number of milli-satoshis.

Fails only if msats is greater than 21 million Bitcoin (in milli-satoshis).

pub const fn from_sats(sats: u64) -> Result<Self, ()>

Constructs a new Amount for the given number of satoshis.

Fails only if sats is greater than 21 million Bitcoin (in satoshis).

pub const fn saturating_add(self, rhs: Amount) -> Amount

Adds an Amount to this Amount, saturating to avoid overflowing 21 million bitcoin.

pub const fn saturating_sub(self, rhs: Amount) -> Amount

Subtracts an Amount from this Amount, saturating to avoid underflowing.

pub fn btc_decimal_rounding_up_to_sats(self) -> FormattedAmount

Returns an object that implements core::fmt::Display which writes out the amount, in bitcoin, with a decimal point between the whole-bitcoin and partial-bitcoin amounts, with any milli-satoshis rounded up to the next whole satoshi.

Trait Implementations

impl Clone for Amount

fn clone(&self) -> Amount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Amount

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

Formats the value using the given formatter.

impl From<Amount> for Amount

fn from(amt: BitcoinAmount) -> Amount

Converts to this type from the input type.

impl Ord for Amount

fn cmp(&self, other: &Amount) -> 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 Amount

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

fn partial_cmp(&self, other: &Amount) -> 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 Amount

impl Eq for Amount

impl StructuralPartialEq for Amount