Enum dock_staking_rewards::types::HighRateRewardsState

pub enum HighRateRewardsState {
    None,
    StartingInNextEra {
        duration: DurationInEras,
    },
    Active {
        ends_after: DurationInEras,
    },
}

Denotes the current state of the high-rate rewards.

Variants

None

High-rate rewards are disabled.

StartingInNextEra

Fields

duration: DurationInEras

High-rate rewards will start in the next era and last for duration eras.

Active

Fields

ends_after: DurationInEras

High-rate rewards are currently active and will end after ends_after eras.

Implementations

impl HighRateRewardsState

pub fn try_next(&mut self) -> Result<Self, Self>

Attempts to switch Self to the next state returning next Ok(Self) on update and Err(Self) if nothing was changed. Returned Self is the copy of the final value.

This function defines the following transitions:

• High-rate rewards were activated.

HighRateRewardsState::StartingInNextEra { duration: TWO_ERAS }.try_next(), /* => */ Ok(HighRateRewardsState::Active { ends_after: TWO_ERAS })

• High-rate rewards passed one more era, so the remaining amount is decreased by 1.

HighRateRewardsState::Active { ends_after: TWO_ERAS }.try_next(), /* => */ Ok(HighRateRewardsState::Active { ends_after: ONE_ERA })

• High-rate rewards ended, switching back to the default state.

HighRateRewardsState::Active { ends_after: ONE_ERA }.try_next(), /* => */ Ok(HighRateRewardsState::None)

• No state transition for the default state.

HighRateRewardsState::None.try_next(), /* => */ Err(HighRateRewardsState::None)

pub fn inc_duration_or_init(&mut self, inc_duration: DurationInEras) -> Self

Increments duration of Self using supplied amount returning copied Self. If Self is None, it will be replaced by StartingInNextEra with the given duration. Overflow will be adjusted to the upper bound - u16::MAX.

Examples

HighRateRewardsState::StartingInNextEra { duration: ONE_ERA }.inc_duration_or_init(TWO_ERAS), /* => */ HighRateRewardsState::StartingInNextEra { duration: THREE_ERAS }

HighRateRewardsState::Active { ends_after: ONE_ERA }.inc_duration_or_init(TWO_ERAS), /* => */ HighRateRewardsState::Active { ends_after: THREE_ERAS }

HighRateRewardsState::None.inc_duration_or_init(TWO_ERAS), /* => */ HighRateRewardsState::StartingInNextEra { duration: TWO_ERAS }

pub fn is_active(&self) -> bool

Checks if the given HighRateRewardsState is in the Active phase.

Trait Implementations

impl Clone for HighRateRewardsState

fn clone(&self) -> HighRateRewardsState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HighRateRewardsState

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

Formats the value using the given formatter.

impl Decode for HighRateRewardsState

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 HighRateRewardsState

fn default() -> Self

Returns the “default value” for a type.

impl Encode for HighRateRewardsState

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, 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 MaxEncodedLen for HighRateRewardsState

fn max_encoded_len() -> usize

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

impl PartialEq<HighRateRewardsState> for HighRateRewardsState

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

type Identity = HighRateRewardsState

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Copy for HighRateRewardsState

impl EncodeLike<HighRateRewardsState> for HighRateRewardsState

impl Eq for HighRateRewardsState

impl StructuralEq for HighRateRewardsState

impl StructuralPartialEq for HighRateRewardsState