Struct CuSimAppLifecycle 

pub struct CuSimAppLifecycle<S, L, A, State = Initialized> { /* private fields */ }

Compile-time enforced lifecycle for a CuSimApplication.

Simulation counterpart of CuAppLifecycle: same states and transitions, with each transition threading the sim_callback the simulation runtime requires. Replay primitives (replay_recorded_copperlist, restore_keyframe) are framework-level and stay on the raw traits.

Implementations

impl<S, L, A, State> CuSimAppLifecycle<S, L, A, State>

pub fn inner(&self) -> &A

Read-only access to the wrapped application.

pub fn into_inner(self) -> A

Consumes the wrapper and returns the application, dropping the compile-time lifecycle tracking.

impl<S, L, A> CuSimAppLifecycle<S, L, A>

where S: SectionStorage, L: UnifiedLogWrite<S> + 'static, A: CuSimApplication<S, L>,

pub fn new(app: A) -> CuSimAppLifecycle<S, L, A>

Wraps a freshly built simulation application in the Initialized state.

impl<S, L, A, State> CuSimAppLifecycle<S, L, A, State>

where S: SectionStorage, L: UnifiedLogWrite<S> + 'static, A: CuSimApplication<S, L>, State: Startable,

pub fn start( self, sim_callback: &mut impl for<'z> FnMut(<A as CuSimApplication<S, L>>::Step<'z>) -> SimOverride, ) -> Result<CuSimAppLifecycle<S, L, A, Running>, SimLifecycleError<S, L, A>>

Starts all tasks, transitioning to Running.

On failure the application may be partially started; it is returned typed Faulted inside the error so it can be cleaned up.

pub fn run_until_shutdown( self, sim_callback: &mut impl for<'z> FnMut(<A as CuSimApplication<S, L>>::Step<'z>) -> SimOverride, ) -> Result<CuSimAppLifecycle<S, L, A, Stopped>, SimLifecycleError<S, L, A>>

Runs the full lifecycle (start, iterate until shutdown, stop), transitioning to Stopped on success.

impl<S, L, A> CuSimAppLifecycle<S, L, A, Running>

where S: SectionStorage, L: UnifiedLogWrite<S> + 'static, A: CuSimApplication<S, L>,

pub fn run_one_iteration( &mut self, sim_callback: &mut impl for<'z> FnMut(<A as CuSimApplication<S, L>>::Step<'z>) -> SimOverride, ) -> Result<(), CuError>

Executes one iteration of the runtime. An iteration error does not change the lifecycle state: the caller decides whether to keep iterating or stop.

impl<S, L, A, State> CuSimAppLifecycle<S, L, A, State>

where S: SectionStorage, L: UnifiedLogWrite<S> + 'static, A: CuSimApplication<S, L>, State: Stoppable,

pub fn stop( self, sim_callback: &mut impl for<'z> FnMut(<A as CuSimApplication<S, L>>::Step<'z>) -> SimOverride, ) -> Result<CuSimAppLifecycle<S, L, A, Stopped>, SimLifecycleError<S, L, A>>

Stops all tasks, transitioning to Stopped. From Faulted this is a best-effort cleanup. On failure the application is handed back typed Faulted again.

Trait Implementations

impl<S, L, A> CuSimApplication<S, L> for CuSimAppLifecycle<S, L, A>

where S: SectionStorage, L: UnifiedLogWrite<S> + 'static, A: CuSimApplication<S, L>,

Available on crate feature std only.

Legacy escape hatch mirroring the CuApplication impl on CuAppLifecycle: pre-typestate simulation code compiles unchanged against what build() returns and only picks up deprecation warnings.

type Step<'z> = <A as CuSimApplication<S, L>>::Step<'z>

The type representing a simulation step that can be overridden

fn get_original_config() -> String

Returns the original configuration as a string, typically loaded from a RON file. This configuration represents the default settings for the application before any overrides.

fn mission_id() -> Option<&'static str>

Returns the mission id this generated application is bound to, when applicable.

fn start_all_tasks( &mut self, sim_callback: &mut impl for<'z> FnMut(<CuSimAppLifecycle<S, L, A> as CuSimApplication<S, L>>::Step<'z>) -> SimOverride, ) -> Result<(), CuError>

👎Deprecated since 1.2.0:

use the typed transition start() on the handle returned by build()

Starts all tasks managed by the application/runtime in simulation mode.

fn run_one_iteration( &mut self, sim_callback: &mut impl for<'z> FnMut(<CuSimAppLifecycle<S, L, A> as CuSimApplication<S, L>>::Step<'z>) -> SimOverride, ) -> Result<(), CuError>

👎Deprecated since 1.2.0:

use run_one_iteration() on the Running handle from build()?.start()?

Executes a single iteration of copper-generated runtime in simulation mode.

fn run( &mut self, sim_callback: &mut impl for<'z> FnMut(<CuSimAppLifecycle<S, L, A> as CuSimApplication<S, L>>::Step<'z>) -> SimOverride, ) -> Result<(), CuError>

👎Deprecated since 1.2.0:

use the typed transition run_until_shutdown() on the handle returned by build()

Runs indefinitely looping over run_one_iteration in simulation mode

fn stop_all_tasks( &mut self, sim_callback: &mut impl for<'z> FnMut(<CuSimAppLifecycle<S, L, A> as CuSimApplication<S, L>>::Step<'z>) -> SimOverride, ) -> Result<(), CuError>

👎Deprecated since 1.2.0:

use the typed transition stop() on the Running handle

Stops all tasks managed by the application/runtime in simulation mode.

fn restore_keyframe(&mut self, freezer: &KeyFrame) -> Result<(), CuError>

Restore all tasks from the given frozen state

impl<S, L, A, State> Debug for CuSimAppLifecycle<S, L, A, State>

Available on crate feature std only.

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

Formats the value using the given formatter.

impl<S, L, A, State> Deref for CuSimAppLifecycle<S, L, A, State>

Available on crate feature std only.

Read access to the wrapped application in every lifecycle state.

type Target = A

The resulting type after dereferencing.

fn deref(&self) -> &A

Dereferences the value.

impl<S, L, A> DerefMut for CuSimAppLifecycle<S, L, A>

Available on crate feature std only.

Mutable access only before the application is started, mirroring CuAppLifecycle.

fn deref_mut(&mut self) -> &mut A

Mutably dereferences the value.