Struct PpmFee 

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

A fee with sub-satoshi precision: the undivided numerator of a ppm fee calculation, in millionths of a satoshi.

Produced by Amount * PpmFeeRate. To be usable as money it must be rounded to whole satoshis with PpmFee::to_amount_ceil; keeping the numerator exact until then lets sums of fees round once on the total instead of once per term.

Implementations

impl PpmFee

pub const ZERO: PpmFee

The zero amount.

pub fn to_sat_ceil(self) -> Option<u64>

The fee in satoshis, rounded up to the next whole satoshi. Returns None if the result exceeds u64::MAX.

pub fn to_amount_ceil(self) -> Option<Amount>

The fee rounded up to the next whole satoshi. Returns None if the result exceeds u64::MAX satoshis.

pub fn checked_add(self, other: PpmFee) -> Option<PpmFee>

Returns None if the sum overflows.

Trait Implementations

impl Clone for PpmFee

fn clone(&self) -> PpmFee

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PpmFee

impl Debug for PpmFee

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

Formats the value using the given formatter.

impl Eq for PpmFee

impl Hash for PpmFee

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 PpmFee

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PpmFee

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