simulacra 0.1.0

A deterministic discrete-event simulation engine for message flow across large computer networks
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

//! Simulacra: A deterministic discrete-event simulation engine.
//!
//! Simulacra is designed for modeling message flow across large computer networks
//! with pluggable latency, jitter, and failure models.
//!
//! # Core Concepts
//!
//! - **Time**: Simulated time advances by events, not wall clock time
//! - **Events**: The atomic units of causality, ordered by time and sequence
//! - **Determinism**: Given the same seed and inputs, simulations produce identical results
//!
//! # Example
//!
//! ```
//! use simulacra::{Simulation, Time, Duration};
//!
//! // Define your event type
//! #[derive(Debug)]
//! enum Event {
//!     Tick(u32),
//! }
//!
//! // Create and run a simulation
//! let mut sim = Simulation::new();
//! sim.schedule(Time::from_millis(100), Event::Tick(1));
//! sim.schedule(Time::from_millis(200), Event::Tick(2));
//!
//! let stats = sim.run(|sim, event| {
//!     println!("At {}: {:?}", sim.now(), event);
//! });
//!
//! println!("Processed {} events", stats.events_processed);
//! ```
//!
//! # Deterministic Random Numbers
//!
//! ```
//! use simulacra::SimRng;
//!
//! let mut rng = SimRng::new(42);
//!
//! // Same seed produces identical sequences
//! let mut rng2 = SimRng::new(42);
//! assert_eq!(rng.u64(100), rng2.u64(100));
//! ```

pub mod net;
pub mod parallel;
mod queue;
mod rng;
pub mod scenario;
mod sim;
pub mod task;
mod time;
pub mod trace;

pub use queue::{EventQueue, Scheduled};
pub use rng::SimRng;
pub use scenario::Scenario;
pub use sim::{Simulation, SimulationStats};
pub use time::{Duration, Time};
#[cfg(feature = "serde")]
pub use trace::TraceLoadError;
pub use trace::{
    ReplayError, TRACE_SCHEMA_VERSION, Trace, TraceEvent, TraceMismatch, TraceRecorder,
};

// Re-export commonly used network types at crate root for convenience
pub use net::{
    DropPolicy, DropReason, FixedLatency, LatencyModel, Message, MessageId, NetConfig, NetEvent,
    NetTraceDropReason, NetTraceEvent, Network, NetworkStats, NodeId, OverheadPlusJitter,
    PercentageJitter, Route, RunContext, SpikyLatency, Topology, TopologyBuilder, TracedNetwork,
    UniformJitter,
};

// Re-export task types
pub use task::{
    CancellationToken, Either, Envelope, NodeContext, Recv, RecvTimeout, Select2, SendFut, Sleep,
    TaskId, TaskSim, TaskSimBuilder, TaskSimStats, select2,
};