Skip to main content

EventContext

Struct EventContext 

Source
pub struct EventContext<'a, S, A, Props, R>
where A: Agent,
{ /* private fields */ }
Expand description

Context passed to event-queue action callbacks during EventQueueModel::step_event.

Provides safe mutable access to space, properties, RNG, and the event queue without aliasing the currently-borrowed agent.

Implementations§

Source§

impl<'a, S, A, Props, R> EventContext<'a, S, A, Props, R>
where A: Agent,

Source

pub fn space(&self) -> &S

Immutable reference to the simulation space.

Source

pub fn space_mut(&mut self) -> &mut S

Mutable reference to the simulation space.

Source

pub fn properties(&self) -> &Props

Immutable reference to user-defined model properties.

Source

pub fn properties_mut(&mut self) -> &mut Props

Mutable reference to user-defined model properties.

Source

pub fn rng(&mut self) -> &mut R

Mutable reference to the model’s RNG.

Source

pub fn time(&self) -> f64

Current model time (the timestamp of the event being processed).

Source

pub fn add_event(&mut self, agent_id: AgentId, event_idx: usize, dt: f64)

Schedule a new event relative to the current time.

§Panics

Panics if dt is negative, NaN, or infinite.

Source

pub fn defer_remove_agent(&mut self, id: AgentId)

Schedule an agent for removal after the current event completes.

Source

pub fn defer_insert_agent(&mut self, agent: A)

Schedule an agent for insertion after the current event completes.

Auto Trait Implementations§

§

impl<'a, S, A, Props, R> Freeze for EventContext<'a, S, A, Props, R>

§

impl<'a, S, A, Props, R> RefUnwindSafe for EventContext<'a, S, A, Props, R>

§

impl<'a, S, A, Props, R> Send for EventContext<'a, S, A, Props, R>
where S: Send, Props: Send, R: Send, A: Send,

§

impl<'a, S, A, Props, R> Sync for EventContext<'a, S, A, Props, R>
where S: Sync, Props: Sync, R: Sync, A: Sync,

§

impl<'a, S, A, Props, R> Unpin for EventContext<'a, S, A, Props, R>

§

impl<'a, S, A, Props, R> UnsafeUnpin for EventContext<'a, S, A, Props, R>

§

impl<'a, S, A, Props, R> !UnwindSafe for EventContext<'a, S, A, Props, R>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more