Struct Weight

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

Re-export everything from the units::weight module. 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.

impl AddAssign for Weight

fn add_assign(&mut self, rhs: Weight)

Performs the += operation.

impl Clone for Weight

fn clone(&self) -> Weight

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Weight

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

Formats the value using the given formatter.

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.

impl Display for Weight

Alternative will display the unit.

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

Formats the value using the given formatter.

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.

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.

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.

impl DivAssign<u64> for Weight

fn div_assign(&mut self, rhs: u64)

Performs the /= operation.

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.

impl Hash for Weight

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

where __H: Hasher,

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

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.

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.

impl MulAssign<u64> for Weight

fn mul_assign(&mut self, rhs: u64)

Performs the *= operation.

impl Ord for Weight

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

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

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

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.

impl SubAssign for Weight

fn sub_assign(&mut self, rhs: Weight)

Performs the -= operation.

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