Struct Amount 

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

A bitcoin amount integer type.

Implementations

impl Amount

pub fn from_btc<T>(btc: T) -> Amount

where T: IntoBtc,

Creates an Amount from the given type.

pub fn from_sat(sat: i64) -> Amount

Creates a new Amount from a satoshi amount.

pub fn zero() -> Amount

Returns the additive identity of Amount.

pub fn one() -> Amount

Returns the multiplicative identity of Amount.

pub fn max_value() -> Amount

Maximum value that can fit in an Amount.

pub fn min_value() -> Amount

Minimum value that can fit in an Amount.

pub fn into_inner(self) -> i64

Converts this Amount to the inner satoshis.

Trait Implementations

impl Add for Amount

type Output = Amount

The resulting type after applying the + operator.

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

Performs the + operation.

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

impl Debug for Amount

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

Formats the value using the given formatter.

impl Div for Amount

type Output = Amount

The resulting type after applying the / operator.

fn div(self, rhs: Amount) -> Self::Output

Performs the / operation.

impl Eq for Amount

impl FromStr for Amount

type Err = ParseAmountError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Mul for Amount

type Output = Amount

The resulting type after applying the * operator.

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

Performs the * operation.

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

impl Sub for Amount

type Output = Amount

The resulting type after applying the - operator.

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

Performs the - operation.