Struct pallet_state_trie_migration::pallet::MigrationTask

pub struct MigrationTask<T: Config> { /* private fields */ }

A migration task stored in state.

It tracks the last top and child keys read.

Implementations

impl<T: Config> MigrationTask<T>

pub fn migrate_until_exhaustion( &mut self, limits: MigrationLimits, ) -> Result<(), Error<T>>

Migrate keys until either of the given limits are exhausted, or if no more top keys exist.

Note that this can return after the first migration tick that causes exhaustion, specifically in the case of the size constrain. The reason for this is that before reading a key, we simply cannot know how many bytes it is. In other words, this should not be used in any environment where resources are strictly bounded (e.g. a parachain), but it is acceptable otherwise (relay chain, offchain workers).

Trait Implementations

impl<T: Clone + Config> Clone for MigrationTask<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Config> Debug for MigrationTask<T>

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

Formats the value using the given formatter.

impl<T: Config> Decode for MigrationTask<T>

where ProgressOf<T>: Decode, PhantomData<T>: Default,

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

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

fn default() -> Self

Returns the “default value” for a type.

impl<T: Config> Encode for MigrationTask<T>

where ProgressOf<T>: Encode,

fn size_hint(&self) -> usize

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

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

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<T: Config> MaxEncodedLen for MigrationTask<T>

where ProgressOf<T>: MaxEncodedLen,

fn max_encoded_len() -> usize

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

impl<T: PartialEq + Config> PartialEq for MigrationTask<T>

fn eq(&self, other: &MigrationTask<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 MigrationTask<T>

where ProgressOf<T>: TypeInfo + 'static, PhantomData<T>: TypeInfo + 'static, T: Config + 'static,

type Identity = MigrationTask<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> EncodeLike for MigrationTask<T>

where ProgressOf<T>: Encode,

impl<T: Eq + Config> Eq for MigrationTask<T>

impl<T: Config> StructuralPartialEq for MigrationTask<T>