Struct massa_versioning::versioning::MipState

pub struct MipState {
    pub(crate) state: ComponentState,
    pub(crate) history: BTreeMap<AdvanceLW, ComponentStateTypeId>,
}

Wrapper of ComponentState (in order to keep state history)

Fields

state: ComponentState

history: BTreeMap<AdvanceLW, ComponentStateTypeId>

Implementations

impl MipState

pub fn new(defined: MassaTime) -> Self

Create

pub fn reset_from(&self) -> Option<Self>

Create a new state from an existing state - resulting state will be at state “Defined”

pub fn on_advance(&mut self, input: &Advance)

Advance the state Can be called as multiple times as it will only store what changes the state in history

pub fn is_consistent_with( &self, mip_info: &MipInfo, ) -> Result<(), IsConsistentError>

Given a corresponding MipInfo, check if state is consistent it is consistent if state can be at this position (e.g. can it be at state “Started” according to given time range) if history is consistent with current state Return false for state == ComponentState::Error

pub fn state_at( &self, ts: MassaTime, start: MassaTime, timeout: MassaTime, activation_delay: MassaTime, ) -> Result<ComponentStateTypeId, StateAtError>

Query state at given timestamp TODO: add doc for start & timeout parameter? why do we need them?

pub fn activation_at(&self, mip_info: &MipInfo) -> Option<MassaTime>

Return the time when state will go from LockedIn to Active, None if not already LockedIn

pub fn is_final(&self) -> bool

Return True if state can not change anymore (e.g. Active, Failed or Error)

Trait Implementations

impl Clone for MipState

fn clone(&self) -> MipState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MipState

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

Formats the value using the given formatter.

impl Deserializer<MipState> for MipStateDeserializer

fn deserialize<'a, E: ParseError<&'a [u8]> + ContextError<&'a [u8]>>( &self, buffer: &'a [u8], ) -> IResult<&'a [u8], MipState, E>

Deserialize a value T from a buffer of u8.

impl PartialEq for MipState

fn eq(&self, other: &MipState) -> 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 Serializer<MipState> for MipStateSerializer

fn serialize( &self, value: &MipState, buffer: &mut Vec<u8>, ) -> Result<(), SerializeError>

Serialize a value T into a buffer of u8.

impl StructuralPartialEq for MipState