Struct walletd_bitcoin::BitcoinAmount

pub struct BitcoinAmount {
    pub satoshi: u64,
}

Contains a field representing the amount of satoshis in the amount. Has functions to convert to and from the main unit (BTC) and the smallest unit (satoshi).

Fields

satoshi: u64

The number of satoshis (the smallest unit of the bitcoin currency) in the amount.

There are 100 million satoshis per bitcoin (BTC).

Implementations

impl BitcoinAmount

pub fn from_btc(btc_amount: f64) -> Self

Returns a BitcoinAmount struct from a decimal value representing the amount in BTC.

pub fn from_satoshi(satoshi_amount: u64) -> Self

Returns a BitcoinAmount struct from an integer value representing the amount in satoshis.

pub fn btc(&self) -> f64

Returns the amount in BTC as a f64.

pub fn satoshi(&self) -> u64

Returns the amount in satoshis as a u64.

Trait Implementations

impl Add<BitcoinAmount> for BitcoinAmount

type Output = Result<BitcoinAmount, Error>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Result<Self, Error>

Performs the + operation.

impl Clone for BitcoinAmount

fn clone(&self) -> BitcoinAmount

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CryptoAmount for BitcoinAmount

fn from_main_unit_decimal_value(value: f64) -> Self

In the units of main “big” unit (a floating point number, not an integer subdivision) using decimal value, for bitcoin BTC, ethereum ETH, etc. The CryptoAmount is a wrapper around a floating point number and the default integer value stored is in the smallest unit of the coin. For example this would be satoshi for bitcoin, wei for ethereum, etc. The decimal value is the floating point number representation in the main unit of the coin, for example BTC, ETH, etc.

fn from_smallest_unit_integer_value(value: u64) -> Self

Creates a new CryptoAmount from the smallest unit of the coin, for example satoshi for bitcoin, wei for ethereum, etc.

fn to_main_unit_decimal_value(&self) -> f64

Returns the decimal value of the CryptoAmount, this is the floating point number representation in the main unit of the coin, for example BTC, ETH, etc.

fn to_smallest_unit_integer_value(&self) -> u64

Returns the integer value of the CryptoAmount, this is the integer representation in the smallest unit of the coin, for example satoshi for bitcoin, wei for ethereum, etc.

fn new() -> Selfwhere Self: Sized,

Constructs a new CryptoAmount with a value of 0.0

impl Default for BitcoinAmount

fn default() -> BitcoinAmount

Returns the “default value” for a type.

impl Mul<f64> for BitcoinAmount

type Output = Result<BitcoinAmount, Error>

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl Ord for BitcoinAmount

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<BitcoinAmount> for BitcoinAmount

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

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

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 PartialOrd<BitcoinAmount> for BitcoinAmount

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub<BitcoinAmount> for BitcoinAmount

type Output = Result<BitcoinAmount, Error>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Result<Self, Error>

Performs the - operation.

impl Copy for BitcoinAmount

impl Eq for BitcoinAmount

impl StructuralEq for BitcoinAmount

impl StructuralPartialEq for BitcoinAmount