Struct Weight 

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

The weight of a transaction or block.

This is an integer newtype representing weight in weight units. It provides protection against mixing up the types, conversion functions, and basic formatting.

Implementations

impl Weight

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

Constructs a new Weight from weight units.

pub const fn to_wu(self) -> u64

Returns raw weight units.

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

impl Weight

pub const ZERO: Self

Zero weight units (wu).

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

pub const MIN: Self

Minimum possible value (0 wu).

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

pub const MAX: Self

Maximum possible value.

pub const WITNESS_SCALE_FACTOR: u64

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

pub const MAX_BLOCK: Self

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

pub const MIN_TRANSACTION: Self

The minimum transaction weight for a valid serialized transaction.

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

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

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

Constructs a new Weight from virtual bytes, returning None if an overflow occurred.

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

👎Deprecated since 1.0.0-rc.0: use from_vb_unchecked instead

Constructs a new Weight from virtual bytes panicking if an overflow occurred.

Panics

If the conversion from virtual bytes overflows.

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

Constructs a new Weight from virtual bytes without an overflow check.

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

👎Deprecated since 1.0.0-rc.1: use from_wu instead

Constructs a new Weight from witness size.

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

👎Deprecated since 1.0.0-rc.1: use from_vb or from_vb_unchecked instead

Constructs a new Weight from non-witness size.

Panics

If the conversion from virtual bytes overflows.

pub const fn to_kwu_floor(self) -> u64

Converts to kilo weight units rounding down.

pub const fn to_kwu_ceil(self) -> u64

Converts to kilo weight units rounding up.

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

Checked addition.

Computes self + rhs returning None if an overflow occurred.

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

Checked subtraction.

Computes self - rhs returning None if an overflow occurred.

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

Checked multiplication.

Computes self * rhs returning None if an overflow occurred.

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

Checked division.

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

pub const fn mul_by_fee_rate(self, fee_rate: FeeRate) -> NumOpResult<Amount>

Checked fee rate multiplication.

Computes the absolute fee amount for a given FeeRate at this weight. 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.

Trait Implementations

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

type Output = <Weight as Add>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Weight) -> Self::Output

Performs the + operation.

impl Add<&Weight> for Weight

type Output = <Weight as Add>::Output

The resulting type after applying the + operator.

fn add(self, rhs: &Weight) -> Self::Output

Performs the + operation.

impl Add<Weight> for &Weight

type Output = <Weight as Add>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Weight) -> Self::Output

Performs the + operation.

impl Add for Weight

type Output = Weight

The resulting type after applying the + operator.

fn add(self, rhs: Weight) -> Self::Output

Performs the + operation.

impl AddAssign<&Weight> for Weight

fn add_assign(&mut self, rhs: &Weight)

Performs the += operation.

impl AddAssign for Weight

fn add_assign(&mut self, rhs: Weight)

Performs the += operation.

impl<'a> Arbitrary<'a> for Weight

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.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Binary for Weight

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

Formats the value using the given formatter.

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

Formats the value using the given formatter.

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

Available on crate feature serde only.

fn deserialize<D>(d: D) -> Result<Self, D::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

Formats the value using the given formatter.

impl<'a> Div<&'a NonZero<u64>> for &Weight

type Output = <Weight as Div<NonZero<u64>>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &NonZeroU64) -> Self::Output

Performs the / operation.

impl Div<&NonZero<u64>> for Weight

type Output = <Weight as Div<NonZero<u64>>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &NonZeroU64) -> Self::Output

Performs the / operation.

impl<'a> Div<&'a Weight> for &Amount

type Output = <Amount as Div<Weight>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &Weight) -> Self::Output

Performs the / operation.

impl<'a> Div<&'a Weight> for &NumOpResult<Amount>

type Output = <NumOpResult<Amount> as Div<Weight>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &Weight) -> Self::Output

Performs the / operation.

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

type Output = <Weight as Div>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &Weight) -> Self::Output

Performs the / operation.

impl Div<&Weight> for Amount

type Output = <Amount as Div<Weight>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &Weight) -> Self::Output

Performs the / operation.

impl Div<&Weight> for NumOpResult<Amount>

type Output = <NumOpResult<Amount> as Div<Weight>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &Weight) -> Self::Output

Performs the / operation.

impl Div<&Weight> for Weight

type Output = <Weight as Div>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &Weight) -> Self::Output

Performs the / operation.

impl<'a> Div<&'a u64> for &Weight

type Output = <Weight as Div<u64>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &u64) -> Self::Output

Performs the / operation.

impl Div<&u64> for Weight

type Output = <Weight as Div<u64>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: &u64) -> Self::Output

Performs the / operation.

impl Div<NonZero<u64>> for &Weight

type Output = <Weight as Div<NonZero<u64>>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: NonZeroU64) -> Self::Output

Performs the / operation.

impl Div<NonZero<u64>> for Weight

type Output = Weight

The resulting type after applying the / operator.

fn div(self, rhs: NonZeroU64) -> Self::Output

Performs the / operation.

impl Div<Weight> for &Amount

type Output = <Amount as Div<Weight>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: Weight) -> Self::Output

Performs the / operation.

impl Div<Weight> for &NumOpResult<Amount>

type Output = <NumOpResult<Amount> as Div<Weight>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: Weight) -> Self::Output

Performs the / operation.

impl Div<Weight> for &Weight

type Output = <Weight as Div>::Output

The resulting type after applying the / operator.

fn div(self, rhs: Weight) -> Self::Output

Performs the / operation.

impl Div<Weight> for Amount

type Output = NumOpResult<FeeRate>

The resulting type after applying the / operator.

fn div(self, rhs: Weight) -> Self::Output

Performs the / operation.

impl Div<Weight> for NumOpResult<Amount>

type Output = NumOpResult<FeeRate>

The resulting type after applying the / operator.

fn div(self, rhs: Weight) -> Self::Output

Performs the / operation.

impl Div<u64> for &Weight

type Output = <Weight as Div<u64>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: u64) -> Self::Output

Performs the / operation.

impl Div<u64> for Weight

type Output = Weight

The resulting type after applying the / operator.

fn div(self, rhs: u64) -> Self::Output

Performs the / operation.

impl Div for Weight

type Output = u64

The resulting type after applying the / operator.

fn div(self, rhs: Weight) -> Self::Output

Performs the / operation.

impl DivAssign<u64> for Weight

fn div_assign(&mut self, rhs: u64)

Performs the /= operation.

impl From<Weight> for u64

fn from(value: Weight) -> Self

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<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Weight

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

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

Formats the value using the given formatter.

impl<'a> Mul<&'a FeeRate> for &Weight

type Output = <Weight as Mul<FeeRate>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&FeeRate> for Weight

type Output = <Weight as Mul<FeeRate>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a NumOpResult<FeeRate>> for &Weight

type Output = <Weight as Mul<NumOpResult<FeeRate>>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&NumOpResult<FeeRate>> for Weight

type Output = <Weight as Mul<NumOpResult<FeeRate>>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a Weight> for &FeeRate

type Output = <FeeRate as Mul<Weight>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a Weight> for &NumOpResult<FeeRate>

type Output = <NumOpResult<FeeRate> as Mul<Weight>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a Weight> for &u64

type Output = <u64 as Mul<Weight>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Weight> for FeeRate

type Output = <FeeRate as Mul<Weight>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Weight> for NumOpResult<FeeRate>

type Output = <NumOpResult<FeeRate> as Mul<Weight>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Weight> for u64

type Output = <u64 as Mul<Weight>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<&'a u64> for &Weight

type Output = <Weight as Mul<u64>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&u64> for Weight

type Output = <Weight as Mul<u64>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<FeeRate> for &Weight

type Output = <Weight as Mul<FeeRate>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<FeeRate> for Weight

type Output = NumOpResult<Amount>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<NumOpResult<FeeRate>> for &Weight

type Output = <Weight as Mul<NumOpResult<FeeRate>>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<NumOpResult<FeeRate>> for Weight

type Output = NumOpResult<Amount>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Weight> for &FeeRate

type Output = <FeeRate as Mul<Weight>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Weight> for &NumOpResult<FeeRate>

type Output = <NumOpResult<FeeRate> as Mul<Weight>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Weight> for &u64

type Output = <u64 as Mul<Weight>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Weight> for FeeRate

type Output = NumOpResult<Amount>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Weight> for NumOpResult<FeeRate>

type Output = NumOpResult<Amount>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Weight> for u64

type Output = Weight

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<u64> for &Weight

type Output = <Weight as Mul<u64>>::Output

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<u64> for Weight

type Output = Weight

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<u64> for Weight

fn mul_assign(&mut self, rhs: u64)

Performs the *= operation.

impl Octal for Weight

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

Formats the value using the given formatter.

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<'a> Rem<&'a Weight> for &Weight

type Output = <Weight as Rem>::Output

The resulting type after applying the % operator.

fn rem(self, rhs: &Weight) -> Self::Output

Performs the % operation.

impl Rem<&Weight> for Weight

type Output = <Weight as Rem>::Output

The resulting type after applying the % operator.

fn rem(self, rhs: &Weight) -> Self::Output

Performs the % operation.

impl<'a> Rem<&'a u64> for &Weight

type Output = <Weight as Rem<u64>>::Output

The resulting type after applying the % operator.

fn rem(self, rhs: &u64) -> Self::Output

Performs the % operation.

impl Rem<&u64> for Weight

type Output = <Weight as Rem<u64>>::Output

The resulting type after applying the % operator.

fn rem(self, rhs: &u64) -> Self::Output

Performs the % operation.

impl Rem<Weight> for &Weight

type Output = <Weight as Rem>::Output

The resulting type after applying the % operator.

fn rem(self, rhs: Weight) -> Self::Output

Performs the % operation.

impl Rem<u64> for &Weight

type Output = <Weight as Rem<u64>>::Output

The resulting type after applying the % operator.

fn rem(self, rhs: u64) -> Self::Output

Performs the % operation.

impl Rem<u64> for Weight

type Output = Weight

The resulting type after applying the % operator.

fn rem(self, rhs: u64) -> Self::Output

Performs the % operation.

impl Rem for Weight

type Output = u64

The resulting type after applying the % operator.

fn rem(self, rhs: Weight) -> Self::Output

Performs the % operation.

impl RemAssign<u64> for Weight

fn rem_assign(&mut self, rhs: u64)

Performs the %= operation.

impl Serialize for Weight

Available on crate feature serde only.

fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

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

type Output = <Weight as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, rhs: &Weight) -> Self::Output

Performs the - operation.

impl Sub<&Weight> for Weight

type Output = <Weight as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, rhs: &Weight) -> Self::Output

Performs the - operation.

impl Sub<Weight> for &Weight

type Output = <Weight as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, rhs: Weight) -> Self::Output

Performs the - operation.

impl Sub for Weight

type Output = Weight

The resulting type after applying the - operator.

fn sub(self, rhs: Weight) -> Self::Output

Performs the - operation.

impl SubAssign<&Weight> for Weight

fn sub_assign(&mut self, rhs: &Weight)

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

where I: Iterator<Item = &'a Self>,

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

impl Sum for Weight

fn sum<I>(iter: I) -> Self

where I: Iterator<Item = Self>,

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<Self, Self::Error>

Performs the conversion.

impl TryFrom<Box<str>> for Weight

Available on crate feature alloc only.

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 Weight

Available on crate feature alloc only.

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

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

Formats the value using the given formatter.

impl Copy for Weight

impl Eq for Weight

impl StructuralPartialEq for Weight