Struct StorageVersion

pub struct StorageVersion(/* private fields */);

The storage version of a pallet.

Each storage version of a pallet is stored in the state under a fixed key. See STORAGE_VERSION_STORAGE_KEY_POSTFIX for how this key is built.

Implementations

impl StorageVersion

pub const fn new(version: u16) -> Self

Creates a new instance of Self.

pub fn storage_key<P: PalletInfoAccess>() -> [u8; 32]

Returns the storage key for a storage version.

See STORAGE_VERSION_STORAGE_KEY_POSTFIX on how this key is built.

pub fn put<P: PalletInfoAccess>(&self)

Put this storage version for the given pallet into the storage.

It will use the storage key that is associated with the given Pallet.

Panics

This function will panic iff Pallet can not be found by PalletInfo. In a runtime that is put together using construct_runtime! this should never happen.

It will also panic if this function isn’t executed in an externalities provided environment.

pub fn get<P: PalletInfoAccess>() -> Self

Get the storage version of the given pallet from the storage.

It will use the storage key that is associated with the given Pallet.

Panics

This function will panic iff Pallet can not be found by PalletInfo. In a runtime that is put together using construct_runtime! this should never happen.

It will also panic if this function isn’t executed in an externalities provided environment.

pub fn exists<P: PalletInfoAccess>() -> bool

Returns if the storage version key for the given pallet exists in storage.

See STORAGE_VERSION_STORAGE_KEY_POSTFIX on how this key is built.

Panics

This function will panic iff Pallet can not be found by PalletInfo. In a runtime that is put together using construct_runtime! this should never happen.

It will also panic if this function isn’t executed in an externalities provided environment.

Trait Implementations

impl Add<u16> for StorageVersion

type Output = StorageVersion

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for StorageVersion

fn clone(&self) -> StorageVersion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StorageVersion

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

Formats the value using the given formatter.

impl Decode for StorageVersion

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 Default for StorageVersion

fn default() -> StorageVersion

Returns the “default value” for a type.

impl Encode for StorageVersion

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<__CodecOutputReturn, __CodecUsingEncodedCallback: FnOnce(&[u8]) -> __CodecOutputReturn>( &self, f: __CodecUsingEncodedCallback, ) -> __CodecOutputReturn

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

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl Ord for StorageVersion

fn cmp(&self, other: &StorageVersion) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<u16> for StorageVersion

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for StorageVersion

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<u16> for StorageVersion

fn partial_cmp(&self, other: &u16) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd for StorageVersion

fn partial_cmp(&self, other: &StorageVersion) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: GetStorageVersion<InCodeStorageVersion = StorageVersion> + PalletInfoAccess> StoreInCodeStorageVersion<T> for StorageVersion

fn store_in_code_storage_version()

Write the in-code storage version on-chain.

impl Copy for StorageVersion

impl EncodeLike for StorageVersion

impl Eq for StorageVersion

impl StructuralPartialEq for StorageVersion