Struct frame_support::dispatch::PostDispatchInfo

pub struct PostDispatchInfo {
    pub actual_weight: Option<Weight>,
    pub pays_fee: Pays,
}

Weight information that is only available post dispatch. NOTE: This can only be used to reduce the weight or fee, not increase it.

Fields

actual_weight: Option<Weight>

Actual weight consumed by a call or None which stands for the worst case static weight.

pays_fee: Pays

Whether this transaction should pay fees when all is said and done.

Implementations

impl PostDispatchInfo

pub fn calc_unspent(&self, info: &DispatchInfo) -> Weight

Calculate how much (if any) weight was not used by the Dispatchable.

pub fn calc_actual_weight(&self, info: &DispatchInfo) -> Weight

Calculate how much weight was actually spent by the Dispatchable.

Examples found in repository

src/dispatch.rs (line 236)

pub fn extract_actual_weight(result: &DispatchResultWithPostInfo, info: &DispatchInfo) -> Weight {
	match result {
		Ok(post_info) => post_info,
		Err(err) => &err.post_info,
	}
	.calc_actual_weight(info)
}

/// Extract the actual pays_fee from a dispatch result if any or fall back to the default weight.
pub fn extract_actual_pays_fee(result: &DispatchResultWithPostInfo, info: &DispatchInfo) -> Pays {
	match result {
		Ok(post_info) => post_info,
		Err(err) => &err.post_info,
	}
	.pays_fee(info)
}

/// Weight information that is only available post dispatch.
/// NOTE: This can only be used to reduce the weight or fee, not increase it.
#[derive(Clone, Copy, Eq, PartialEq, Default, RuntimeDebug, Encode, Decode, TypeInfo)]
pub struct PostDispatchInfo {
	/// Actual weight consumed by a call or `None` which stands for the worst case static weight.
	pub actual_weight: Option<Weight>,
	/// Whether this transaction should pay fees when all is said and done.
	pub pays_fee: Pays,
}

impl PostDispatchInfo {
	/// Calculate how much (if any) weight was not used by the `Dispatchable`.
	pub fn calc_unspent(&self, info: &DispatchInfo) -> Weight {
		info.weight - self.calc_actual_weight(info)
	}

pub fn pays_fee(&self, info: &DispatchInfo) -> Pays

Determine if user should actually pay fees at the end of the dispatch.

Examples found in repository

src/dispatch.rs (line 245)

pub fn extract_actual_pays_fee(result: &DispatchResultWithPostInfo, info: &DispatchInfo) -> Pays {
	match result {
		Ok(post_info) => post_info,
		Err(err) => &err.post_info,
	}
	.pays_fee(info)
}

Trait Implementations

impl Clone for PostDispatchInfo

fn clone(&self) -> PostDispatchInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PostDispatchInfo

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

Formats the value using the given formatter.

impl Decode for PostDispatchInfo

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

Attempt to deserialise the value from input.

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 PostDispatchInfo

fn default() -> PostDispatchInfo

Returns the “default value” for a type.

impl Encode for PostDispatchInfo

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

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

fn size_hint(&self) -> usize

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

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

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    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<()> for PostDispatchInfo

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<(Option<Weight>, Pays)> for PostDispatchInfo

fn from(post_weight_info: (Option<Weight>, Pays)) -> Self

Converts to this type from the input type.

impl From<(Option<u64>, Pays)> for PostDispatchInfo

fn from(post_weight_info: (Option<u64>, Pays)) -> Self

Converts to this type from the input type.

impl From<Option<Weight>> for PostDispatchInfo

fn from(actual_weight: Option<Weight>) -> Self

Converts to this type from the input type.

impl From<Option<u64>> for PostDispatchInfo

fn from(maybe_actual_computation: Option<u64>) -> Self

Converts to this type from the input type.

impl From<Pays> for PostDispatchInfo

fn from(pays_fee: Pays) -> Self

Converts to this type from the input type.

impl PartialEq<PostDispatchInfo> for PostDispatchInfo

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

fn print(&self)

Print the object.

impl TypeInfo for PostDispatchInfo

type Identity = PostDispatchInfo

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Copy for PostDispatchInfo

impl EncodeLike<PostDispatchInfo> for PostDispatchInfo

impl Eq for PostDispatchInfo

impl StructuralEq for PostDispatchInfo

impl StructuralPartialEq for PostDispatchInfo