Struct frame_support::dispatch::PerDispatchClass

pub struct PerDispatchClass<T> { /* private fields */ }

A struct holding value for each DispatchClass.

Implementations

impl<T> PerDispatchClass<T>

pub fn new(val: impl Fn(DispatchClass) -> T) -> Self

Create new PerDispatchClass with the same value for every class.

pub fn get_mut(&mut self, class: DispatchClass) -> &mut T

Get a mutable reference to current value of given class.

Examples found in repository

src/dispatch.rs (line 419)

	pub fn set(&mut self, new: T, class: impl OneOrMany<DispatchClass>) {
		for class in class.into_iter() {
			*self.get_mut(class) = new.clone();
		}
	}
}

impl PerDispatchClass<Weight> {
	/// Returns the total weight consumed by all extrinsics in the block.
	pub fn total(&self) -> Weight {
		let mut sum = Weight::zero();
		for class in DispatchClass::all() {
			sum = sum.saturating_add(*self.get(*class));
		}
		sum
	}

	/// Add some weight of a specific dispatch class, saturating at the numeric bounds of `Weight`.
	pub fn add(&mut self, weight: Weight, class: DispatchClass) {
		let value = self.get_mut(class);
		*value = value.saturating_add(weight);
	}

	/// Try to add some weight of a specific dispatch class, returning Err(()) if overflow would
	/// occur.
	pub fn checked_add(&mut self, weight: Weight, class: DispatchClass) -> Result<(), ()> {
		let value = self.get_mut(class);
		*value = value.checked_add(&weight).ok_or(())?;
		Ok(())
	}

	/// Subtract some weight of a specific dispatch class, saturating at the numeric bounds of
	/// `Weight`.
	pub fn sub(&mut self, weight: Weight, class: DispatchClass) {
		let value = self.get_mut(class);
		*value = value.saturating_sub(weight);
	}

pub fn get(&self, class: DispatchClass) -> &T

Get current value for given class.

Examples found in repository

src/dispatch.rs (line 429)

	pub fn total(&self) -> Weight {
		let mut sum = Weight::zero();
		for class in DispatchClass::all() {
			sum = sum.saturating_add(*self.get(*class));
		}
		sum
	}

impl<T: Clone> PerDispatchClass<T>

pub fn set(&mut self, new: T, class: impl OneOrMany<DispatchClass>)

Set the value of given class.

impl PerDispatchClass<Weight>

pub fn total(&self) -> Weight

Returns the total weight consumed by all extrinsics in the block.

pub fn add(&mut self, weight: Weight, class: DispatchClass)

Add some weight of a specific dispatch class, saturating at the numeric bounds of Weight.

pub fn checked_add(
    &mut self,
    weight: Weight,
    class: DispatchClass
) -> Result<(), ()>

Try to add some weight of a specific dispatch class, returning Err(()) if overflow would occur.

pub fn sub(&mut self, weight: Weight, class: DispatchClass)

Subtract some weight of a specific dispatch class, saturating at the numeric bounds of Weight.

Trait Implementations

impl<T: Clone> Clone for PerDispatchClass<T>

fn clone(&self) -> PerDispatchClass<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for PerDispatchClass<T>where
    T: Debug,

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

Formats the value using the given formatter.

impl<T> Decode for PerDispatchClass<T>where
    T: Decode,

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<T: Default> Default for PerDispatchClass<T>

fn default() -> PerDispatchClass<T>

Returns the “default value” for a type.

impl<T> Encode for PerDispatchClass<T>where
    T: Encode,

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<T> MaxEncodedLen for PerDispatchClass<T>where
    T: MaxEncodedLen,

fn max_encoded_len() -> usize

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

impl<T: PartialEq> PartialEq<PerDispatchClass<T>> for PerDispatchClass<T>

fn eq(&self, other: &PerDispatchClass<T>) -> 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> TypeInfo for PerDispatchClass<T>where
    T: TypeInfo + 'static,

type Identity = PerDispatchClass<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T> EncodeLike<PerDispatchClass<T>> for PerDispatchClass<T>where
    T: Encode,

impl<T: Eq> Eq for PerDispatchClass<T>

impl<T> StructuralEq for PerDispatchClass<T>

impl<T> StructuralPartialEq for PerDispatchClass<T>