Struct frame_support::weights::Weight

pub struct Weight { /* private fields */ }

Implementations

impl Weight

pub const fn set_ref_time(self, c: u64) -> Weight

Set the reference time part of the weight.

pub const fn set_proof_size(self, c: u64) -> Weight

Set the storage size part of the weight.

pub const fn ref_time(&self) -> u64

Return the reference time part of the weight.

pub const fn proof_size(&self) -> u64

Return the storage size part of the weight.

pub fn ref_time_mut(&mut self) -> &mut u64

Return a mutable reference to the reference time part of the weight.

pub fn proof_size_mut(&mut self) -> &mut u64

Return a mutable reference to the storage size part of the weight.

pub const MAX: Weight = _

The maximal weight in all dimensions.

pub fn min(&self, other: Weight) -> Weight

Get the conservative min of self and other weight.

pub fn max(&self, other: Weight) -> Weight

Get the aggressive max of self and other weight.

pub fn try_add(&self, other: &Weight, limit: &Weight) -> Option<Weight>

Try to add some other weight while upholding the limit.

pub const fn from_parts(ref_time: u64, proof_size: u64) -> Weight

Construct Weight from weight parts, namely reference time and proof size weights.

pub const fn from_all(value: u64) -> Weight

Construct Weight from the same weight for all parts.

pub const fn saturating_add(self, rhs: Weight) -> Weight

Saturating Weight addition. Computes self + rhs, saturating at the numeric bounds of all fields instead of overflowing.

pub const fn saturating_sub(self, rhs: Weight) -> Weight

Saturating Weight subtraction. Computes self - rhs, saturating at the numeric bounds of all fields instead of overflowing.

pub const fn saturating_mul(self, scalar: u64) -> Weight

Saturating Weight scalar multiplication. Computes self.field * scalar for all fields, saturating at the numeric bounds of all fields instead of overflowing.

pub const fn saturating_div(self, scalar: u64) -> Weight

Saturating Weight scalar division. Computes self.field / scalar for all fields, saturating at the numeric bounds of all fields instead of overflowing.

pub const fn saturating_pow(self, exp: u32) -> Weight

Saturating Weight scalar exponentiation. Computes self.field.pow(exp) for all fields, saturating at the numeric bounds of all fields instead of overflowing.

pub fn saturating_accrue(&mut self, amount: Weight)

Increment Weight by amount via saturating addition.

pub fn saturating_reduce(&mut self, amount: Weight)

Reduce Weight by amount via saturating subtraction.

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

Checked Weight addition. Computes self + rhs, returning None if overflow occurred.

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

Checked Weight subtraction. Computes self - rhs, returning None if overflow occurred.

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

Checked Weight scalar multiplication. Computes self.field * scalar for each field, returning None if overflow occurred.

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

Checked Weight scalar division. Computes self.field / scalar for each field, returning None if overflow occurred.

pub const fn checked_div_per_component(self, other: &Weight) -> Option<u64>

Calculates how many other fit into self.

Divides each component of self against the same component of other. Returns the minimum of all those divisions. Returns None in case all components of other are zero.

This returns Some even if some components of other are zero as long as there is at least one non-zero component in other. The division for this particular component will then yield the maximum value (e.g u64::MAX). This is because we assume not every operation and hence each Weight will necessarily use each resource.

pub fn checked_accrue(&mut self, amount: Weight) -> Option<()>

Try to increase self by amount via checked addition.

pub fn checked_reduce(&mut self, amount: Weight) -> Option<()>

Try to reduce self by amount via checked subtraction.

pub const fn zero() -> Weight

Return a Weight where all fields are zero.

pub const fn add_ref_time(self, scalar: u64) -> Weight

Constant version of Add for ref_time component with u64.

Is only overflow safe when evaluated at compile-time.

pub const fn add_proof_size(self, scalar: u64) -> Weight

Constant version of Add for proof_size component with u64.

Is only overflow safe when evaluated at compile-time.

pub const fn sub_ref_time(self, scalar: u64) -> Weight

Constant version of Sub for ref_time component with u64.

Is only overflow safe when evaluated at compile-time.

pub const fn sub_proof_size(self, scalar: u64) -> Weight

Constant version of Sub for proof_size component with u64.

Is only overflow safe when evaluated at compile-time.

pub const fn div(self, scalar: u64) -> Weight

Constant version of Div with u64.

Is only overflow safe when evaluated at compile-time.

pub const fn mul(self, scalar: u64) -> Weight

Constant version of Mul with u64.

Is only overflow safe when evaluated at compile-time.

pub const fn any_gt(self, other: Weight) -> bool

Returns true if any of self’s constituent weights is strictly greater than that of the other’s, otherwise returns false.

pub const fn all_gt(self, other: Weight) -> bool

Returns true if all of self’s constituent weights is strictly greater than that of the other’s, otherwise returns false.

pub const fn any_lt(self, other: Weight) -> bool

Returns true if any of self’s constituent weights is strictly less than that of the other’s, otherwise returns false.

pub const fn all_lt(self, other: Weight) -> bool

Returns true if all of self’s constituent weights is strictly less than that of the other’s, otherwise returns false.

pub const fn any_gte(self, other: Weight) -> bool

Returns true if any of self’s constituent weights is greater than or equal to that of the other’s, otherwise returns false.

pub const fn all_gte(self, other: Weight) -> bool

Returns true if all of self’s constituent weights is greater than or equal to that of the other’s, otherwise returns false.

pub const fn any_lte(self, other: Weight) -> bool

Returns true if any of self’s constituent weights is less than or equal to that of the other’s, otherwise returns false.

pub const fn all_lte(self, other: Weight) -> bool

Returns true if all of self’s constituent weights is less than or equal to that of the other’s, otherwise returns false.

pub const fn any_eq(self, other: Weight) -> bool

Returns true if any of self’s constituent weights is equal to that of the other’s, otherwise returns false.

Trait Implementations

impl Add for Weight

type Output = Weight

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Weight

fn add_assign(&mut self, other: Weight)

Performs the += operation.

impl Bounded for Weight

fn min_value() -> Weight

Returns the smallest finite number this type can represent

fn max_value() -> Weight

Returns the largest finite number this type can represent

impl CheckedAdd for Weight

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

Adds two numbers, checking for overflow. If overflow happens, None is returned.

impl CheckedSub for Weight

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

Subtracts two numbers, checking for underflow. If underflow happens, None is returned.

impl<T> ClassifyDispatch<T> for Weight

fn classify_dispatch(&self, _: T) -> DispatchClass

Classify the dispatch function based on input data target of type T. When implementing this for a dispatchable, T will be a tuple of all arguments given to the function (except origin).

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<(), Error>

Formats the value using the given formatter.

impl Decode for Weight

fn decode<__CodecInputEdqy>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Weight, Error>

where __CodecInputEdqy: Input,

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Default for Weight

fn default() -> Weight

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

impl<T> Div<T> for Weight

where u64: Div<T, Output = u64>, T: Copy,

type Output = Weight

The resulting type after applying the / operator.

fn div(self, b: T) -> Weight

Performs the / operation.

impl Encode for Weight

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

where __CodecOutputEdqy: Output + ?Sized,

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl From<(u64, u64)> for Weight

fn from(value: (u64, u64)) -> Weight

Converts to this type from the input type.

impl From<u64> for Weight

fn from(value: u64) -> Weight

Converts to this type from the input type.

impl JsonSchema for Weight

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl MaxEncodedLen for Weight

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<T> Mul<T> for Weight

where T: Mul<u64, Output = u64> + Copy,

type Output = Weight

The resulting type after applying the * operator.

fn mul(self, b: T) -> Weight

Performs the * operation.

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<T> PaysFee<T> for Weight

fn pays_fee(&self, _: T) -> Pays

impl Printable for Weight

fn print(&self)

Print the object.

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

Performs the - operation.

impl SubAssign for Weight

fn sub_assign(&mut self, other: Weight)

Performs the -= operation.

impl TypeInfo for Weight

type Identity = Weight

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T> WeighData<T> for Weight

fn weigh_data(&self, _: T) -> Weight

Weigh the data T given by target. When implementing this for a dispatchable, T will be a tuple of all arguments given to the function (except origin).

impl Zero for Weight

fn zero() -> Weight

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Copy for Weight

impl EncodeLike for Weight

impl Eq for Weight

impl StructuralPartialEq for Weight