Struct bdk_chain::bitcoin::FeeRate

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

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) -> FeeRate

Constructs FeeRate from satoshis per 1000 weight units.

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

Constructs FeeRate from satoshis per virtual bytes.

§Errors

Returns None on arithmetic overflow.

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

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<FeeRate>

Checked multiplication.

Computes self * rhs returning None if overflow occurred.

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

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.

None is returned if an overflow occurred.

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

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

This is equivalent to Self::checked_mul_by_weight().

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

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

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

Trait Implementations§

§

impl Clone for FeeRate

§

fn clone(&self) -> FeeRate

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for FeeRate

§

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

Formats the value using the given formatter. Read more
§

impl<'de> Deserialize<'de> for FeeRate

§

fn deserialize<__D>( __deserializer: __D ) -> Result<FeeRate, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl Display for FeeRate

Alternative will display the unit.

§

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

Formats the value using the given formatter. Read more
§

impl From<FeeRate> for u64

§

fn from(value: FeeRate) -> u64

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<FeeRate, <FeeRate as FromStr>::Err>

Parses a string s to return a value of this type. Read more
§

impl Hash for FeeRate

§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

impl Mul<FeeRate> for Weight

Computes ceiling so that fee computation is conservative.

§

type Output = Amount

The resulting type after applying the * operator.
§

fn mul(self, rhs: FeeRate) -> <Weight as Mul<FeeRate>>::Output

Performs the * operation. Read more
§

impl Mul<Weight> for FeeRate

§

type Output = Amount

The resulting type after applying the * operator.
§

fn mul(self, rhs: Weight) -> <FeeRate as Mul<Weight>>::Output

Performs the * operation. Read more
§

impl Ord for FeeRate

§

fn cmp(&self, other: &FeeRate) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
§

impl PartialEq for FeeRate

§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method 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. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
§

impl Serialize for FeeRate

§

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

Serialize this value into the given Serde serializer. Read more
§

impl TryFrom<&str> for FeeRate

§

type Error = ParseIntError

The type returned in the event of a conversion error.
§

fn try_from(s: &str) -> Result<FeeRate, <FeeRate as TryFrom<&str>>::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<FeeRate, <FeeRate as TryFrom<Box<str>>>::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<FeeRate, <FeeRate as TryFrom<String>>::Error>

Performs the conversion.
§

impl Copy for FeeRate

§

impl Eq for FeeRate

§

impl StructuralPartialEq for FeeRate

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,