Struct PpmFeeRate 

pub struct PpmFeeRate(pub u64);

Tuple Fields

0: u64

Implementations

impl PpmFeeRate

pub const ZERO: PpmFeeRate

The zero amount.

pub const ONE_PERCENT: PpmFeeRate

Represents a fee rate of 1%.

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

Multiplies the given amount by this fee rate. Returns None if the result overflows.

Trait Implementations

impl Clone for PpmFeeRate

fn clone(&self) -> PpmFeeRate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PpmFeeRate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PpmFeeRate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for PpmFeeRate

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 Mul<PpmFeeRate> for Amount

fn mul(self, ppm: PpmFeeRate) -> Self::Output

Calculates a fee value for the current amount using a parts-per-million (PPM) rate.

Returns

Returns the calculated fee as an Amount. The result is truncated using integer division, and any overflow is capped with u64::MAX.

Example

use ark::fees::PpmFeeRate;
use bitcoin::Amount;

let fee_chargeable_amount = Amount::from_sat(10_000);
let ppm = PpmFeeRate(5_000); // 0.5%
let fee = fee_chargeable_amount * ppm;
assert_eq!(fee, Amount::from_sat(50)); // 10,000 * 5,000 / 1,000,000 = 50

type Output = Amount

The resulting type after applying the * operator.

impl Ord for PpmFeeRate

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for PpmFeeRate

impl Eq for PpmFeeRate

impl StructuralPartialEq for PpmFeeRate