Struct bitcoin_units::Weight

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

Available on crate feature alloc only.

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

Directly constructs Weight from weight units.

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

Directly constructs Weight from usize weight units.

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

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

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

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

Constructs Weight from virtual bytes without an overflow check.

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

Constructs Weight from witness size.

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

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

Checked addition.

Computes self + rhs returning None if an overflow occurred.

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

Checked subtraction.

Computes self - rhs returning None if an overflow occurred.

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

Checked multiplication.

Computes self * rhs returning None if an overflow occurred.

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

Checked division.

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

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

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

Performs the + operation.

impl AddAssign for Weight

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Weight

fn clone(&self) -> Weight

Returns a copy 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

fn deserialize<__D>(__deserializer: __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 Div<Weight> for Amount

type Output = 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

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

Performs the * operation.

impl Mul<Weight> for FeeRate

type Output = 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

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

Restrict a value to a certain interval.

impl PartialEq for Weight

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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::Ok, __S::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) -> Self::Output

Performs the - operation.

impl SubAssign for Weight

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

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

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

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

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

Method which 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

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

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

impl Eq for Weight

impl StructuralPartialEq for Weight