Struct simrs::State

pub struct State { /* private fields */ }

State of a simulation holding all queues and arbitrary values in a store value.

Implementations

impl State

pub fn insert<V: 'static>(&mut self, value: V) -> Key<V>

Inserts an arbitrary value to the value store. Learn more in the documentation for Key.

pub fn remove<V: 'static>(&mut self, key: Key<V>) -> Option<V>

Removes a value of type V from the value store. Learn more in the documentation for Key.

pub fn get<V: 'static>(&self, key: Key<V>) -> Option<&V>

Gets a immutable reference to a value of a type V from the value store. Learn more in the documentation for Key.

pub fn get_mut<V: 'static>(&mut self, key: Key<V>) -> Option<&mut V>

Gets a mutable reference to a value of a type V from the value store. Learn more in the documentation for Key.

pub fn add_queue<Q: Queue + 'static>(&mut self, queue: Q) -> QueueId<Q>

Creates a new unbounded queue, returning its ID.

pub fn send<Q: Queue + 'static>(
    &mut self,
    queue: QueueId<Q>,
    value: Q::Item
) -> Result<(), PushError>

Sends value to the queue. This is a shorthand for queue_mut(queue).push(value).

Errors

It returns an error if the queue is full.

pub fn recv<Q: Queue + 'static>(&mut self, queue: QueueId<Q>) -> Option<Q::Item>

Pops the first value from the queue. It returns None if the queue is empty. This is a shorthand for queue_mut(queue).pop(value).

pub fn len<Q: Queue + 'static>(&self, queue: QueueId<Q>) -> usize

Checks the number of elements in the queue. This is a shorthand for queue(queue).len().

pub fn queue<Q: Queue + 'static>(&self, queue: QueueId<Q>) -> &Q

Returns a immutable reference to the queue by the given ID.

pub fn queue_mut<Q: Queue + 'static>(&mut self, queue: QueueId<Q>) -> &mut Q

Returns a mutable reference to the queue by the given ID.

Trait Implementations

impl Default for State

fn default() -> State

Returns the “default value” for a type.