Struct handshake_types::amount::Amount

pub struct Amount(_);

Methods

impl Amount

pub const ZERO: Amount

The zero amount.

pub const ONE_DOO: Amount

Exactly one satoshi.

pub const ONE_HNS: Amount

Exactly one bitcoin.

pub fn from_doos(dollary_doo: u64) -> Amount

Create an Amount with dollary doo precision and the given number of dollary doos.

pub fn as_doos(self) -> u64

Get the number of satoshis in this Amount.

pub fn min_value() -> Amount

The maximum value of an Amount. The minimum value of an Amount.

pub fn from_hns(hns: f64) -> Result<Amount, ParseAmountError>

Convert from a value expressing bitcoins to an Amount.

pub fn from_str_in(
    s: &str,
    denom: Denomination
) -> Result<Amount, ParseAmountError>

Parse a decimal string as a value in the given denomination.

Note: This only parses the value string. If you want to parse a value with denomination, use FromStr.

pub fn from_str_with_denomination(s: &str) -> Result<Amount, ParseAmountError>

Parses amounts with denomination suffix like they are produced with [to_string_with_denomination] or with fmt::Display. If you want to parse only the amount without the denomination, use [from_str_in].

pub fn to_float_in(&self, denom: Denomination) -> f64

Express this Amount as a floating-point value in the given denomination.

Please be aware of the risk of using floating-point numbers.

pub fn as_btc(&self) -> f64

Express this Amount as a floating-point value in Bitcoin.

Equivalent to to_float_in(Denomination::Bitcoin).

Please be aware of the risk of using floating-point numbers.

pub fn from_float_in(
    value: f64,
    denom: Denomination
) -> Result<Amount, ParseAmountError>

Convert this Amount in floating-point notation with a given denomination. Can return error if the amount is too big, too precise or negative.

Please be aware of the risk of using floating-point numbers.

pub fn fmt_value_in(&self, f: &mut dyn Write, denom: Denomination) -> Result

Format the value of this Amount in the given denomination.

Does not include the denomination.

pub fn to_string_in(&self, denom: Denomination) -> String

Get a string number of this Amount in the given denomination.

Does not include the denomination.

pub fn to_string_with_denomination(&self, denom: Denomination) -> String

Get a formatted string of this Amount in the given denomination, suffixed with the abbreviation for the denomination.

pub fn abs(self) -> Amount

Get the absolute value of this Amount.

pub fn checked_add(self, rhs: Amount) -> Option<Amount>

Checked addition. Returns None if overflow occurred.

pub fn checked_sub(self, rhs: Amount) -> Option<Amount>

Checked subtraction. Returns None if overflow occurred.

pub fn checked_mul(self, rhs: u64) -> Option<Amount>

Checked multiplication. Returns None if overflow occurred.

pub fn checked_div(self, rhs: u64) -> Option<Amount>

Checked integer division. Be aware that integer division loses the remainder if no exact division can be made. Returns None if overflow occurred.

pub fn checked_rem(self, rhs: u64) -> Option<Amount>

Checked remainder. Returns None if overflow occurred.

Trait Implementations

impl Clone for Amount

fn clone(&self) -> Amount

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Amount

impl Debug for Amount

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

Formats the value using the given formatter.

impl Eq for Amount

impl PartialEq<Amount> for Amount

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

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

fn ne(&self, other: &Amount) -> bool

This method tests for !=.

impl StructuralEq for Amount

impl StructuralPartialEq for Amount