Struct BitcoinAmount

pub struct BitcoinAmount(pub i64);

Represents the amount of Bitcoin in satoshis

Tuple Fields

0: i64

Implementations

impl BitcoinAmount

pub const ZERO: BitcoinAmount = _

The zero amount.

pub const ONE_SAT: BitcoinAmount = _

Exactly one satoshi.

pub const ONE_BTC: BitcoinAmount = _

Exactly one bitcoin.

pub fn from_satoshi(satoshis: i64) -> Result<Self, AmountError>

pub fn from_ubtc(ubtc_value: i64) -> Result<Self, AmountError>

pub fn from_mbtc(mbtc_value: i64) -> Result<Self, AmountError>

pub fn from_cbtc(cbtc_value: i64) -> Result<Self, AmountError>

pub fn from_dbtc(dbtc_value: i64) -> Result<Self, AmountError>

pub fn from_btc(btc_value: i64) -> Result<Self, AmountError>

Trait Implementations

impl Add for BitcoinAmount

type Output = Result<BitcoinAmount, AmountError>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

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

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

Formats the value using the given formatter.

impl Display for BitcoinAmount

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

Formats the value using the given formatter.

impl Hash for BitcoinAmount

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

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for BitcoinAmount

type Output = Result<BitcoinAmount, AmountError>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl Amount for BitcoinAmount

impl Copy for BitcoinAmount

impl Eq for BitcoinAmount

impl StructuralPartialEq for BitcoinAmount