Struct FeeRate 

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

Fee rate.

This is an integer newtype representing fee rate. It provides protection against mixing up the types, conversion functions, and basic formatting.

NOTE: FeeRate explicitly does not have any format/display trait implementations, as it doesn’t have a standard unit for measure. Users are expected to format it on their own by extracting values in desired units with from_sat_per* functions.

Implementations

impl FeeRate

pub const ZERO: Self

The zero fee rate.

Equivalent to MIN, may better express intent in some contexts.

pub const MIN: Self = Self::ZERO

The minimum possible value.

Equivalent to ZERO, may better express intent in some contexts.

pub const MAX: Self

The maximum possible value.

pub const BROADCAST_MIN: Self

The minimum fee rate required to broadcast a transaction.

The value matches the default Bitcoin Core policy at the time of library release.

pub const DUST: Self

The fee rate used to compute dust amount.

pub const fn from_sat_per_kwu(sat_kwu: u32) -> Self

Constructs a new FeeRate from satoshis per 1000 weight units.

pub const fn from_per_kwu(rate: Amount) -> NumOpResult<Self>

Constructs a new FeeRate from amount per 1000 weight units.

pub const fn from_sat_per_vb(sat_vb: u32) -> Self

Constructs a new FeeRate from satoshis per virtual byte.

pub const fn from_per_vb(rate: Amount) -> NumOpResult<Self>

Constructs a new FeeRate from amount per virtual byte.

pub const fn from_sat_per_kvb(sat_kvb: u32) -> Self

Constructs a new FeeRate from satoshis per kilo virtual bytes (1,000 vbytes).

pub const fn from_per_kvb(rate: Amount) -> NumOpResult<Self>

Constructs a new FeeRate from satoshis per kilo virtual bytes (1,000 vbytes).

pub const fn to_sat_per_kwu_floor(self) -> u64

Converts to sat/kwu rounding down.

pub const fn to_sat_per_kwu_ceil(self) -> u64

Converts to sat/kwu rounding up.

pub const fn to_sat_per_vb_floor(self) -> u64

Converts to sat/vB rounding down.

pub const fn to_sat_per_vb_ceil(self) -> u64

Converts to sat/vB rounding up.

pub const fn to_sat_per_kvb_floor(self) -> u64

Converts to sat/kvb rounding down.

pub const fn to_sat_per_kvb_ceil(self) -> u64

Converts to sat/kvb rounding up.

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

Checked multiplication.

Computes self * rhs, returning None if overflow occurred.

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

Checked division.

Computes self / rhs returning None if rhs == 0.

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

Checked addition.

Computes self + rhs returning None in case of overflow.

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

Checked subtraction.

Computes self - rhs, returning None if overflow occurred.

pub const fn to_fee(self, weight: Weight) -> Amount

Calculates the fee by multiplying this fee rate by weight.

Computes the absolute fee amount for a given Weight at this fee rate. When the resulting fee is a non-integer amount, the amount is rounded up, ensuring that the transaction fee is enough instead of falling short if rounded down.

If the calculation would overflow we saturate to Amount::MAX. Since such a fee can never be paid this is meaningful as an error case while still removing the possibility of silently wrapping.

pub fn fee_wu(self, weight: Weight) -> Option<Amount>

👎Deprecated since 1.0.0-rc.0: use to_fee() instead

Calculates the fee by multiplying this fee rate by weight, in weight units, returning None if an overflow occurred.

This is equivalent to Self::mul_by_weight(weight).ok().

pub fn fee_vb(self, vb: u64) -> Option<Amount>

👎Deprecated since 1.0.0-rc.0: use Weight::from_vb and then to_fee() instead

Calculates the fee by multiplying this fee rate by weight, in virtual bytes, returning None if vb cannot be represented as Weight.

This is equivalent to converting vb to Weight using Weight::from_vb and then calling Self::to_fee.

pub const fn mul_by_weight(self, weight: Weight) -> NumOpResult<Amount>

Checked weight multiplication.

Computes the absolute fee amount for a given Weight at this fee rate. When the resulting fee is a non-integer amount, the amount is rounded up, ensuring that the transaction fee is enough instead of falling short if rounded down.

Trait Implementations

impl<'a> Add<&'a FeeRate> for &FeeRate

type Output = <FeeRate as Add>::Output

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&FeeRate> for FeeRate

type Output = <FeeRate as Add>::Output

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<FeeRate> for &FeeRate

type Output = <FeeRate as Add>::Output

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for FeeRate

type Output = FeeRate

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<&FeeRate> for FeeRate

fn add_assign(&mut self, rhs: &FeeRate)

Performs the += operation.

impl AddAssign for FeeRate

fn add_assign(&mut self, rhs: FeeRate)

Performs the += operation.

impl<'a> Arbitrary<'a> for FeeRate

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for FeeRate

fn clone(&self) -> FeeRate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FeeRate

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

Formats the value using the given formatter.

impl<'a> Div<&'a FeeRate> for &Amount

type Output = <Amount as Div<FeeRate>>::Output

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a> Div<&'a FeeRate> for &NumOpResult<Amount>

type Output = <NumOpResult<Amount> as Div<FeeRate>>::Output

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&FeeRate> for Amount

type Output = <Amount as Div<FeeRate>>::Output

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&FeeRate> for NumOpResult<Amount>

type Output = <NumOpResult<Amount> as Div<FeeRate>>::Output

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a> Div<&'a NonZero<u64>> for &FeeRate

type Output = <FeeRate as Div<NonZero<u64>>>::Output

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<&NonZero<u64>> for FeeRate

type Output = <FeeRate as Div<NonZero<u64>>>::Output

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<FeeRate> for &Amount

type Output = <Amount as Div<FeeRate>>::Output

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<FeeRate> for &NumOpResult<Amount>

type Output = <NumOpResult<Amount> as Div<FeeRate>>::Output

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<FeeRate> for Amount

type Output = NumOpResult<Weight>

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<FeeRate> for NumOpResult<Amount>

type Output = NumOpResult<Weight>

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<NonZero<u64>> for &FeeRate

type Output = <FeeRate as Div<NonZero<u64>>>::Output

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<NonZero<u64>> for FeeRate

type Output = FeeRate

The resulting type after applying the / operator.

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

Performs the / operation.

impl Hash for FeeRate

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<'a> Mul<&'a FeeRate> for &NumOpResult<Weight>

type Output = <NumOpResult<Weight> as Mul<FeeRate>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a FeeRate> for &Weight

type Output = <Weight as Mul<FeeRate>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&FeeRate> for NumOpResult<Weight>

type Output = <NumOpResult<Weight> as Mul<FeeRate>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&FeeRate> for Weight

type Output = <Weight as Mul<FeeRate>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a NumOpResult<Weight>> for &FeeRate

type Output = <FeeRate as Mul<NumOpResult<Weight>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &NumOpResult<Weight>) -> Self::Output

Performs the * operation.

impl Mul<&NumOpResult<Weight>> for FeeRate

type Output = <FeeRate as Mul<NumOpResult<Weight>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: &NumOpResult<Weight>) -> Self::Output

Performs the * operation.

impl<'a> Mul<&'a Weight> for &FeeRate

type Output = <FeeRate as Mul<Weight>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Weight> for FeeRate

type Output = <FeeRate as Mul<Weight>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<FeeRate> for &NumOpResult<Weight>

type Output = <NumOpResult<Weight> as Mul<FeeRate>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<FeeRate> for &Weight

type Output = <Weight as Mul<FeeRate>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<FeeRate> for NumOpResult<Weight>

type Output = NumOpResult<Amount>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<FeeRate> for Weight

type Output = NumOpResult<Amount>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<NumOpResult<Weight>> for &FeeRate

type Output = <FeeRate as Mul<NumOpResult<Weight>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: NumOpResult<Weight>) -> Self::Output

Performs the * operation.

impl Mul<NumOpResult<Weight>> for FeeRate

type Output = NumOpResult<Amount>

The resulting type after applying the * operator.

fn mul(self, rhs: NumOpResult<Weight>) -> Self::Output

Performs the * operation.

impl Mul<Weight> for &FeeRate

type Output = <FeeRate as Mul<Weight>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Weight> for FeeRate

type Output = NumOpResult<Amount>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Ord for FeeRate

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

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

fn partial_cmp(&self, other: &FeeRate) -> 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<'a> Sub<&'a FeeRate> for &FeeRate

type Output = <FeeRate as Sub>::Output

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&FeeRate> for FeeRate

type Output = <FeeRate as Sub>::Output

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<FeeRate> for &FeeRate

type Output = <FeeRate as Sub>::Output

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for FeeRate

type Output = FeeRate

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&FeeRate> for FeeRate

fn sub_assign(&mut self, rhs: &FeeRate)

Performs the -= operation.

impl SubAssign for FeeRate

fn sub_assign(&mut self, rhs: FeeRate)

Performs the -= operation.

impl<'a> Sum<&'a FeeRate> for FeeRate

fn sum<I>(iter: I) -> Self

where I: Iterator<Item = &'a Self>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for FeeRate

fn sum<I>(iter: I) -> Self

where I: Iterator<Item = Self>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for FeeRate

impl Eq for FeeRate

impl StructuralPartialEq for FeeRate