bdk_chain::bitcoin

Struct Weight

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

Represents block weight - the weight of a transaction or block.

This is an integer newtype representing weigth in wu. It provides protection against mixing up the types as well as basic formatting features.

Implementations§

§

impl Weight

pub const ZERO: Weight = _

0 wu.

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

pub const MIN: Weight = _

Minimum possible value (0 wu).

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

pub const MAX: Weight = _

Maximum possible value.

pub const WITNESS_SCALE_FACTOR: u64 = 4u64

The factor that non-witness serialization data is multiplied by during weight calculation.

pub const MAX_BLOCK: Weight = _

The maximum allowed weight for a block, see BIP 141 (network rule).

pub const MIN_TRANSACTION: Weight = _

The minimum transaction weight for a valid serialized transaction.

pub const fn from_wu(wu: u64) -> Weight

Directly constructs Weight from weight units.

pub const fn from_wu_usize(wu: usize) -> Weight

Directly constructs Weight from usize weight units.

pub fn from_kwu(wu: u64) -> Option<Weight>

Constructs Weight from kilo weight units returning None if an overflow occurred.

pub fn from_vb(vb: u64) -> Option<Weight>

Constructs Weight from virtual bytes, returning None on overflow.

pub const fn from_vb_unwrap(vb: u64) -> Weight

Constructs Weight from virtual bytes panicking on overflow.

§Panics

If the conversion from virtual bytes overflows.

pub const fn from_vb_unchecked(vb: u64) -> Weight

Constructs Weight from virtual bytes without an overflow check.

pub const fn from_witness_data_size(witness_size: u64) -> Weight

Constructs Weight from witness size.

pub const fn from_non_witness_data_size(non_witness_size: u64) -> Weight

Constructs Weight from non-witness size.

pub const fn to_wu(self) -> u64

Returns raw weight units.

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

pub const fn to_kwu_floor(self) -> u64

Converts to kilo weight units rounding down.

pub const fn to_vbytes_floor(self) -> u64

Converts to vB rounding down.

pub const fn to_vbytes_ceil(self) -> u64

Converts to vB rounding up.

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

Checked addition.

Computes self + rhs returning None if an overflow occurred.

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

Checked subtraction.

Computes self - rhs returning None if an overflow occurred.

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

Checked multiplication.

Computes self * rhs returning None if an overflow occurred.

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

Checked division.

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

pub fn scale_by_witness_factor(self) -> Option<Weight>

Scale by witness factor.

Computes self * WITNESS_SCALE_FACTOR returning None if an overflow occurred.

Trait Implementations§

§

impl Add for Weight

§

type Output = Weight

The resulting type after applying the + operator.
§

fn add(self, rhs: Weight) -> <Weight as Add>::Output

Performs the + operation. Read more
§

impl AddAssign for Weight

§

fn add_assign(&mut self, rhs: Weight)

Performs the += operation. Read more
§

impl Clone for Weight

§

fn clone(&self) -> Weight

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 Weight

§

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

Formats the value using the given formatter. Read more
§

impl<'de> Deserialize<'de> for Weight

§

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

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

impl Display for Weight

Alternative will display the unit.

§

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

Formats the value using the given formatter. Read more
§

impl Div<Weight> for Amount

§

type Output = FeeRate

The resulting type after applying the / operator.
§

fn div(self, rhs: Weight) -> <Amount as Div<Weight>>::Output

Performs the / operation. Read more
§

impl Div<u64> for Weight

§

type Output = Weight

The resulting type after applying the / operator.
§

fn div(self, rhs: u64) -> <Weight as Div<u64>>::Output

Performs the / operation. Read more
§

impl Div for Weight

§

type Output = u64

The resulting type after applying the / operator.
§

fn div(self, rhs: Weight) -> <Weight as Div>::Output

Performs the / operation. Read more
§

impl DivAssign<u64> for Weight

§

fn div_assign(&mut self, rhs: u64)

Performs the /= operation. Read more
§

impl From<Weight> for u64

§

fn from(value: Weight) -> u64

Converts to this type from the input type.
§

impl FromStr for Weight

§

type Err = ParseIntError

The associated error which can be returned from parsing.
§

fn from_str(s: &str) -> Result<Weight, <Weight as FromStr>::Err>

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

impl Hash for Weight

§

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

§

type Output = Weight

The resulting type after applying the * operator.
§

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

Performs the * operation. Read more
§

impl Mul<u64> for Weight

§

type Output = Weight

The resulting type after applying the * operator.
§

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

Performs the * operation. Read more
§

impl MulAssign<u64> for Weight

§

fn mul_assign(&mut self, rhs: u64)

Performs the *= operation. Read more
§

impl Ord for Weight

§

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

Restrict a value to a certain interval. Read more
§

impl PartialEq for Weight

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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 Weight

§

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

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

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

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

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

impl Serialize for Weight

§

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 Sub for Weight

§

type Output = Weight

The resulting type after applying the - operator.
§

fn sub(self, rhs: Weight) -> <Weight as Sub>::Output

Performs the - operation. Read more
§

impl SubAssign for Weight

§

fn sub_assign(&mut self, rhs: Weight)

Performs the -= operation. Read more
§

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

§

fn sum<I>(iter: I) -> Weight
where I: Iterator<Item = &'a Weight>,

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

impl Sum for Weight

§

fn sum<I>(iter: I) -> Weight
where I: Iterator<Item = Weight>,

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

impl TryFrom<&str> for Weight

§

type Error = ParseIntError

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

fn try_from(s: &str) -> Result<Weight, <Weight as TryFrom<&str>>::Error>

Performs the conversion.
§

impl TryFrom<Box<str>> for Weight

§

type Error = ParseIntError

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

fn try_from(s: Box<str>) -> Result<Weight, <Weight as TryFrom<Box<str>>>::Error>

Performs the conversion.
§

impl TryFrom<String> for Weight

§

type Error = ParseIntError

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

fn try_from(s: String) -> Result<Weight, <Weight as TryFrom<String>>::Error>

Performs the conversion.
§

impl Copy for Weight

§

impl Eq for Weight

§

impl StructuralPartialEq for Weight

Auto Trait Implementations§

§

impl Freeze for Weight

§

impl RefUnwindSafe for Weight

§

impl Send for Weight

§

impl Sync for Weight

§

impl Unpin for Weight

§

impl UnwindSafe for Weight

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
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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,

Source§

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§

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

Source§

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

Source§

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