Struct bitcoin_units::Weight

source ·
pub struct Weight(/* private fields */);
Available on crate feature alloc only.
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§

source§

impl Weight

source

pub const ZERO: Weight = _

0 wu.

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

source

pub const MIN: Weight = _

Minimum possible value (0 wu).

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

source

pub const MAX: Weight = _

Maximum possible value.

source

pub const WITNESS_SCALE_FACTOR: u64 = 4u64

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

source

pub const MAX_BLOCK: Weight = _

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

source

pub const MIN_TRANSACTION: Weight = _

The minimum transaction weight for a valid serialized transaction.

source

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

Directly constructs Weight from weight units.

source

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

Directly constructs Weight from usize weight units.

source

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

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

source

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

Constructs Weight from virtual bytes, returning None on overflow.

source

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.

source

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

Constructs Weight from virtual bytes without an overflow check.

source

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

Constructs Weight from witness size.

source

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

Constructs Weight from non-witness size.

source

pub const fn to_wu(self) -> u64

Returns raw weight units.

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

source

pub const fn to_kwu_floor(self) -> u64

Converts to kilo weight units rounding down.

source

pub const fn to_vbytes_floor(self) -> u64

Converts to vB rounding down.

source

pub const fn to_vbytes_ceil(self) -> u64

Converts to vB rounding up.

source

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

Checked addition.

Computes self + rhs returning None if an overflow occurred.

source

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

Checked subtraction.

Computes self - rhs returning None if an overflow occurred.

source

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

Checked multiplication.

Computes self * rhs returning None if an overflow occurred.

source

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

Checked division.

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

source

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§

source§

impl Add for Weight

§

type Output = Weight

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl AddAssign for Weight

source§

fn add_assign(&mut self, rhs: Self)

Performs the += operation. Read more
source§

impl Clone for Weight

source§

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

impl Debug for Weight

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

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

impl Display for Weight

Alternative will display the unit.

source§

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

Formats the value using the given formatter. Read more
source§

impl Div<Weight> for Amount

§

type Output = FeeRate

The resulting type after applying the / operator.
source§

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

Performs the / operation. Read more
source§

impl Div<u64> for Weight

§

type Output = Weight

The resulting type after applying the / operator.
source§

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

Performs the / operation. Read more
source§

impl Div for Weight

§

type Output = u64

The resulting type after applying the / operator.
source§

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

Performs the / operation. Read more
source§

impl DivAssign<u64> for Weight

source§

fn div_assign(&mut self, rhs: u64)

Performs the /= operation. Read more
source§

impl From<Weight> for u64

source§

fn from(value: Weight) -> Self

Converts to this type from the input type.
source§

impl FromStr for Weight

§

type Err = ParseIntError

The associated error which can be returned from parsing.
source§

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for Weight

source§

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

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

impl Mul<FeeRate> for Weight

Computes ceiling so that fee computation is conservative.

§

type Output = Amount

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl Mul<Weight> for FeeRate

§

type Output = Amount

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl Mul<Weight> for u64

§

type Output = Weight

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl Mul<u64> for Weight

§

type Output = Weight

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl MulAssign<u64> for Weight

source§

fn mul_assign(&mut self, rhs: u64)

Performs the *= operation. Read more
source§

impl Ord for Weight

source§

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

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Weight

source§

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

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

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

impl PartialOrd for Weight

source§

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

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

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

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

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

impl Serialize for Weight

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Sub for Weight

§

type Output = Weight

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl SubAssign for Weight

source§

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation. Read more
source§

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

source§

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

impl Sum for Weight

source§

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

impl TryFrom<&str> for Weight

§

type Error = ParseIntError

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

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl TryFrom<Box<str>> for Weight

§

type Error = ParseIntError

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

fn try_from(s: Box<str>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl TryFrom<String> for Weight

§

type Error = ParseIntError

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

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl Copy for Weight

source§

impl Eq for Weight

source§

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

source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

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

source§

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

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

§

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§

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

§

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

§

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,