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
32
33

//! Shows the use of serializing and deserializing an instance of EventSync.
//! Showing also that time does not pass for a stored EventSync.

use event_sync::EventSync;

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

fn main() {
  // Create the EventSync with 500ms tickrate.
  let event_sync = EventSync::new(TICKRATE);

  // Add some time from creation.
  event_sync.wait_for_x_ticks(2).unwrap();

  // Store the EventSync.
  // This will pause it ensuring that only 2 ticks will have passed once we deserialize.
  let serialized_event_sync = serde_json::to_string(&event_sync).unwrap();

  // Desynchronize the stored and still live EventSync.
  event_sync.wait_for_tick().unwrap();

  // Deserialize the stored EventSync.
  let mut deserialized_event_sync =
    serde_json::from_str::<EventSync>(&serialized_event_sync).unwrap();
  // Unpause the EventSync.
  deserialized_event_sync.unpause().unwrap();

  // Ensure that 2 ticks have still passed for the stored EventSync, even if 3 have technically passed real time.
  assert_eq!(deserialized_event_sync.ticks_since_started(), 2);

  // The stored and still live instances of EventSync are now disconnected.
}