Struct Amount

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

The Amount type can be used to express Bitcoin amounts that support arithmetic and conversion to various denominations. The operations that Amount implements will panic when overflow or underflow occurs. Also note that since the internal representation of amounts is unsigned, subtracting below zero is considered an underflow and will cause a panic.

Implementations

impl Amount

pub fn from_sat(satoshi: u64) -> Self

Create an Amount with satoshi precision and the given number of satoshis.

pub fn from_btc(btc: f64) -> Result<Self, ParseAmountError>

Convert from a value expressing bitcoins to an Amount.

pub fn to_sat(&self) -> u64

Get the number of satoshis in this Amount.

pub fn to_btc(&self) -> f64

Express this Amount as a floating-point value in Bitcoin. Please be aware of the risk of using floating-point numbers.

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

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

Formats the value using the given formatter.

impl From<Amount> for Amount

fn from(core_type: BdkAmount) -> Self

Converts to this type from the input type.

impl From<Amount> for Amount

fn from(ffi_type: Amount) -> Self

Converts to this type from the input type.

impl<UT> LiftRef<UT> for Amount

type LiftType = Arc<Amount>

impl<UT> LowerError<UT> for Amount

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for Amount

type ReturnType = <Arc<Amount> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

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<UT> TypeId<UT> for Amount

const TYPE_ID_META: MetadataBuffer

impl Eq for Amount

impl StructuralPartialEq for Amount