Skip to main content

rusting_core/
schedule.rs

1/// The ordered stages executed by an application's `update` method.
2#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
3pub enum ScheduleStage {
4    Startup,
5    FixedUpdate,
6    Update,
7    PostUpdate,
8    RenderExtract,
9}
10
11/// Summary of work performed during a single application update.
12#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
13pub struct FrameReport {
14    pub fixed_steps: u32,
15    pub exit_requested: bool,
16}
17
18#[cfg(test)]
19mod tests {
20    use std::fmt::Debug;
21    use std::hash::Hash;
22
23    use super::{FrameReport, ScheduleStage};
24
25    #[test]
26    fn frame_report_default_has_no_work_or_exit_request() {
27        assert_eq!(
28            FrameReport::default(),
29            FrameReport {
30                fixed_steps: 0,
31                exit_requested: false,
32            }
33        );
34    }
35
36    #[test]
37    fn schedule_stage_variants_are_distinct_and_debuggable() {
38        let stages = [
39            ScheduleStage::Startup,
40            ScheduleStage::FixedUpdate,
41            ScheduleStage::Update,
42            ScheduleStage::PostUpdate,
43            ScheduleStage::RenderExtract,
44        ];
45
46        for (index, stage) in stages.iter().enumerate() {
47            assert!(!stages[..index].contains(stage));
48        }
49        assert_eq!(
50            format!("{:?}", ScheduleStage::RenderExtract),
51            "RenderExtract"
52        );
53    }
54
55    #[test]
56    fn schedule_types_preserve_their_public_trait_shape() {
57        fn assert_stage_traits<T: Clone + Copy + Debug + Eq + Hash>() {}
58        fn assert_report_traits<T: Clone + Copy + Debug + Default + Eq>() {}
59
60        assert_stage_traits::<ScheduleStage>();
61        assert_report_traits::<FrameReport>();
62    }
63
64    #[test]
65    fn frame_report_fields_are_publicly_constructible_and_readable() {
66        let report = FrameReport {
67            fixed_steps: 3,
68            exit_requested: true,
69        };
70
71        assert_eq!(report.fixed_steps, 3);
72        assert!(report.exit_requested);
73    }
74}