event_sync 0.4.4

A crate that can be used to synchronize events to only occur between fixed gaps of time.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

//! This example shows using the .pause() and .unpause() methods.

use event_sync::EventSync;

/// 500ms between ticks.
const TICKRATE: u32 = 500;

fn main() -> anyhow::Result<()> {
  // Create the EventSync with 500ms tickrate.
  let mut event_sync = EventSync::new(TICKRATE);
  let copied_event_sync = event_sync.clone();
  // Create another instance of EventSync to wait while the other one is paused.
  let other_event_sync = EventSync::new(TICKRATE);

  // Add some time to the first EventSync, then pause it.
  event_sync.wait_for_x_ticks(3)?;
  event_sync.pause();

  assert!(copied_event_sync.is_paused()); // Show that pausing another event sync that's been cloned pauses all event syncs.

  // Use the other EventSync to desync the main one.
  other_event_sync.wait_for_x_ticks(3)?;

  // Unpause the main EventSync, maintaining the fact that 3 ticks and some time have passed.
  event_sync.unpause()?;

  // Ensure that 3 ticks have passed in the main EventSync, even if 6 have technically passed in total.
  assert_eq!(event_sync.ticks_since_started(), 3);

  Ok(())
}