Struct FeeRate

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

Available on crate feature alloc only.

Represents fee rate.

This is an integer newtype representing fee rate in sat/kwu. It provides protection against mixing up the types as well as basic formatting features.

Implementations

impl FeeRate

pub const ZERO: FeeRate = _

0 sat/kwu.

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

pub const MIN: FeeRate = FeeRate::ZERO

Minimum possible value (0 sat/kwu).

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

pub const MAX: FeeRate = _

Maximum possible value.

pub const BROADCAST_MIN: FeeRate = _

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: FeeRate = _

Fee rate used to compute dust amount.

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

Constructs FeeRate from satoshis per 1000 weight units.

pub fn from_sat_per_vb(sat_vb: u64) -> Option<Self>

Constructs FeeRate from satoshis per virtual bytes.

Errors

Returns None on arithmetic overflow.

pub const fn from_sat_per_vb_unchecked(sat_vb: u64) -> Self

Constructs FeeRate from satoshis per virtual bytes without overflow check.

pub const fn to_sat_per_kwu(self) -> u64

Returns raw fee rate.

Can be used instead of into() to avoid inference issues.

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 fn checked_mul(self, rhs: u64) -> Option<Self>

Checked multiplication.

Computes self * rhs returning None if overflow occurred.

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

Checked division.

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

pub fn checked_mul_by_weight(self, rhs: Weight) -> Option<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.

None is returned if an overflow occurred.

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

Checked addition.

Computes self + rhs returning None if overflow occured.

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

Checked subtraction.

Computes self - rhs returning None if overflow occured.

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

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

This is equivalent to Self::checked_mul_by_weight().

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

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

This is equivalent to converting vb to Weight using Weight::from_vb and then calling Self::fee_wu(weight).

Trait Implementations

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

type Output = FeeRate

The resulting type after applying the + operator.

fn add(self, other: &'a FeeRate) -> <FeeRate as Add>::Output

Performs the + operation.

impl Add<&FeeRate> for FeeRate

type Output = FeeRate

The resulting type after applying the + operator.

fn add(self, other: &FeeRate) -> <FeeRate as Add>::Output

Performs the + operation.

impl Add<FeeRate> for &FeeRate

type Output = FeeRate

The resulting type after applying the + operator.

fn add(self, other: FeeRate) -> <FeeRate as Add>::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: Self)

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.

impl Clone for FeeRate

fn clone(&self) -> FeeRate

Returns a copy 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<'de> Deserialize<'de> for FeeRate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FeeRate

Alternative will display the unit.

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

Formats the value using the given formatter.

impl From<FeeRate> for u64

fn from(value: FeeRate) -> Self

Converts to this type from the input type.

impl FromStr for FeeRate

type Err = ParseIntError

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 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 Mul<FeeRate> for Weight

Computes the ceiling so that the fee computation is conservative.

type Output = Amount

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Weight> for FeeRate

type Output = 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 Serialize for FeeRate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, 'b> Sub<&'a FeeRate> for &'b FeeRate

type Output = FeeRate

The resulting type after applying the - operator.

fn sub(self, other: &'a FeeRate) -> <FeeRate as Add>::Output

Performs the - operation.

impl Sub<&FeeRate> for FeeRate

type Output = FeeRate

The resulting type after applying the - operator.

fn sub(self, other: &FeeRate) -> <FeeRate as Add>::Output

Performs the - operation.

impl Sub<FeeRate> for &FeeRate

type Output = FeeRate

The resulting type after applying the - operator.

fn sub(self, other: FeeRate) -> <FeeRate as Add>::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: Self)

Performs the -= operation.

impl TryFrom<&str> for FeeRate

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Box<str>> for FeeRate

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from(s: Box<str>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for FeeRate

type Error = ParseIntError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for FeeRate

impl Eq for FeeRate

impl StructuralPartialEq for FeeRate