Skip to main content

ScenarioStateMachine

Struct ScenarioStateMachine 

Source
pub struct ScenarioStateMachine<S: Copy + PartialEq> { /* private fields */ }
Expand description

A generic multi-stage scenario progression.

Implementations§

Source§

impl<S: Copy + PartialEq> ScenarioStateMachine<S>

Source

pub fn new( stages: Vec<StageConfig<S>>, terminal_stages: Vec<S>, initial: S, started_at: i64, ) -> Self

Source

pub fn status(&self) -> ScenarioStatus

Source

pub fn current_stage(&self) -> S

Source

pub fn history(&self) -> &[(S, i64)]

Every stage entered so far, oldest first, with the timestamp it was entered.

Source

pub fn bars_in_stage(&self) -> u32

Source

pub fn tick(&mut self)

Advances one bar without a stage change; expires the scenario if the current stage’s max_bars is exceeded. No-op once the machine is no longer Active.

Source

pub fn advance(&mut self, next_stage: S, timestamp: i64) -> bool

Transitions to next_stage, resetting the per-stage bar counter. Returns false (no-op) if the machine is not currently Active. Marks the machine Completed if next_stage is one of the configured terminal stages.

Source

pub fn invalidate(&mut self)

Explicitly invalidates the scenario (e.g. a structural break of its setup premise). No-op once no longer Active.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.