Struct frame_support::traits::PalletVersion

pub struct PalletVersion {
    pub major: u16,
    pub minor: u8,
    pub patch: u8,
}

The version of a pallet.

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

Fields

major: u16

The major version of the pallet.

minor: u8

The minor version of the pallet.

patch: u8

The patch version of the pallet.

Implementations

impl PalletVersion

pub fn new(major: u16, minor: u8, patch: u8) -> Self

Creates a new instance of Self.

pub fn storage_key<PI: PalletInfo, Pallet: 'static>() -> Option<[u8; 32]>

Returns the storage key for a pallet version.

See PALLET_VERSION_STORAGE_KEY_POSTFIX on how this key is built.

Returns None if the given PI returned a None as name for the given Pallet.

pub fn put_into_storage<PI: PalletInfo, Pallet: 'static>(&self)

Put this pallet version 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.

Trait Implementations

impl Clone for PalletVersion

fn clone(&self) -> PalletVersion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PalletVersion

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

Formats the value using the given formatter.

impl Decode for PalletVersion

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

Attempt to deserialise the value from input.

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

Attempt to skip the encoded value from input.

pub fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Encode for PalletVersion

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

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

pub fn size_hint(&self) -> usize

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

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

Convert self to an owned vector.

pub 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.

pub fn encoded_size(&self) -> usize

Calculates the encoded size.

impl Ord for PalletVersion

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<PalletVersion> for PalletVersion

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<PalletVersion> for PalletVersion

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl Copy for PalletVersion

impl EncodeLike<PalletVersion> for PalletVersion

impl Eq for PalletVersion

impl StructuralEq for PalletVersion

impl StructuralPartialEq for PalletVersion