Struct Event

pub struct Event {
    pub time: f64,
    pub action: Box<dyn FnMut(&mut EventScheduler) -> Option<String>>,
    pub context: HashMap<String, String>,
    pub active: bool,
}

Represents an event in the simulation.

Each event has a scheduled time (time), an associated action (action) that will be executed when the event occurs, and a context for storing key-value pairs of additional information about the event.

Fields

• time: The time at which the event is scheduled to run.
• action: A closure that represents the task to be performed when the event is triggered. It returns an Option<String> to optionally pass a result when executed.
• context: A map containing any extra contextual information as key-value pairs (both as String).
• active: A boolean indicating if the event is active. If false, the event will not run.

Fields

time: f64

action: Box<dyn FnMut(&mut EventScheduler) -> Option<String>>

context: HashMap<String, String>

active: bool

Implementations

impl Event

pub fn new( time: f64, action: Option<Box<dyn FnMut(&mut EventScheduler) -> Option<String>>>, context: Option<HashMap<String, String>>, ) -> Self

Creates a new Event with the given time, action, and context.

Parameters

• time: The time when the event should be executed.
• action: An optional closure representing the event’s task. Defaults to a no-op (returns None).
• context: An optional HashMap of context information. Defaults to an empty map.

Returns

A new Event instance.

Example

use desru::{Event};

let event = Event::new(5.0, None, None);
assert_eq!(event.time, 5.0);

pub fn run(&mut self, scheduler: &mut EventScheduler) -> Option<String>

Executes the action of the event if it is active.

Returns

• Some(String): The result of the action if the event is active and the action produces a result.
• None: If the event is inactive or the action produces no result.

Example

use desru::{Event, EventScheduler};

let mut scheduler = EventScheduler::new();
let mut event = Event::new(0.0,
                           Some(Box::new(|scheduler| Some("Executed".to_string()))),
                           None);
assert_eq!(event.run(&mut scheduler), Some("Executed".to_string()));

pub fn activate(&mut self)

Sets the event to be active.

pub fn deactivate(&mut self)

Sets the event to be inactive.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Self

Creates a clone of the event.

Note: The action closure is not cloned, since closures cannot be cloned. A placeholder action that returns None is used in the cloned event. The context and other fields are copied as usual.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for Event

fn cmp(&self, other: &Self) -> Ordering

Defines the ordering between two events.

The event with the earlier time has higher priority, enabling the BinaryHeap to act as a priority queue.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Event

fn eq(&self, other: &Self) -> bool

Checks if two events are equal based on their scheduled time.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Event

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

Compares two events based on their time, in reverse order, for use in a max-heap.

This allows events with earlier times to be processed first.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Event