Files
a0_basic_app
a1_vehicle
a2_async_sim
ab_glyph
ab_glyph_rasterizer
adler
adler32
agents
aho_corasick
anyhow
approx
aquamarine
ash
atty
bitflags
bytemuck
byteorder
cache_padded
cfg_if
chrono
color_quant
crc32fast
crossbeam_channel
crossbeam_deque
crossbeam_epoch
crossbeam_utils
deflate
draw2d
either
flexi_logger
generic_array
gif
glfw
glfw_sys
glob
image
indoc
itertools
jpeg_decoder
lazy_static
libc
libloading
log
matrixmultiply
memchr
memoffset
miniz_oxide
nalgebra
base
geometry
linalg
third_party
num_complex
num_cpus
num_integer
num_iter
num_rational
num_traits
owned_ttf_parser
paste
png
proc_macro2
proc_macro_error
proc_macro_error_attr
quote
raw_window_handle
rawpointer
rayon
rayon_core
regex
regex_syntax
scoped_threadpool
scopeguard
semver
semver_parser
serde
serde_derive
simba
smawk
spin_sleep
syn
terminal_size
textwrap
thiserror
thiserror_impl
tiff
time
triple_buffer
ttf_parser
typenum
unicode_width
unicode_xid
unindent
vk_sys
weezl
yansi
 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
34
35
36
37
38
39
40
41
42
43
44
//! This module provides types and functions for modelling an asynchronous,
//! stateful, simulation.

mod worker;

use std::{sync::mpsc::Sender, thread, time::Duration};
use triple_buffer::{Input, Output};

/// A simulation is a type with State. State is advanced in fixed time steps
/// and is presented via the triple-buffer's Input interface.
///
/// The big idea is that a simulation can be run in a separate thread at
/// whatever tick interval the specific implementation requires. Neither the
/// simulation nor the main thread need to block, instead the most recent state
/// is always made available via the triple-buffer.
///
/// Simulations are typically managed by a Worker instance.
pub trait Simulation {
    /// The portion of the simulation's state which will be sent between
    /// threads via the triple buffer.
    ///
    /// The state must be cloneable and defaultable so that it can be safely
    /// passed via the triple buffer.
    type SyncState: 'static + Clone + Send + Sized + Default;

    /// The minimum tick duration for this simulation. If an individual tick()
    /// invocation takes less than this amount of time, then the Worker will
    /// delay the next tick for the difference.
    const TICK_THROTTLE: Duration = Duration::from_millis(15);

    /// Initialize the simulation. Called once right before starting the main
    /// loop.
    fn setup(&mut self, sync: &mut Input<Self::SyncState>);

    /// Advance the simulation by one time step (fixed steps).
    fn tick(&mut self, sync: &mut Input<Self::SyncState>, duration: Duration);
}

/// A Simulation worker owns a thread which runs a simulation asynchronously.
pub struct Worker<TSim: Simulation> {
    join_handle: Option<thread::JoinHandle<()>>,
    stop_sender: Sender<()>,
    output_buffer: Output<TSim::SyncState>,
}