Struct FeeRate

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

Represents fee rate.

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

Implementations

impl FeeRate

pub fn from_sat_per_vb(sat_vb: u64) -> Result<Self, FeeRateError>

Constructs FeeRate from satoshis per virtual bytes.

pub fn from_sat_per_kwu(sat_kwu: u64) -> Self

Constructs FeeRate from satoshis per 1000 weight units.

pub fn to_sat_per_vb_ceil(&self) -> u64

Converts to sat/vB rounding up.

pub fn to_sat_per_vb_floor(&self) -> u64

Converts to sat/vB rounding down.

pub fn to_sat_per_kwu(&self) -> u64

Returns raw fee rate.

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

Calculates fee in satoshis 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).

pub fn fee_wu(&self, wu: u64) -> Option<Arc<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().

Trait Implementations

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

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

Formats the value using the given formatter.

impl From<FeeRate> for FeeRate

fn from(core_type: BdkFeeRate) -> Self

Converts to this type from the input type.

impl From<FeeRate> for FeeRate

fn from(ffi_type: FeeRate) -> Self

Converts to this type from the input type.

impl<UT> LiftRef<UT> for FeeRate

type LiftType = Arc<FeeRate>

impl<UT> LowerError<UT> for FeeRate

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for FeeRate

type ReturnType = <Arc<FeeRate> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for FeeRate

const TYPE_ID_META: MetadataBuffer