Struct simrs::State

pub struct State { /* fields omitted */ }

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

Implementations

impl State

#[must_use = "Discarding key results in leaking inserted value"]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.

#[must_use]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.

#[must_use]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 new_queue<V: 'static>(&mut self) -> QueueId<V>

Creates a new unbounded queue, returning its ID.

pub fn new_bounded_queue<V: 'static>(&mut self, capacity: usize) -> QueueId<V>

Creates a new bounded queue, returning its ID.

pub fn send<V: 'static>(
    &mut self,
    queue: QueueId<V>,
    value: V
) -> Result<(), ()>

Sends value to the queue.

Errors

It returns an error if the queue is full.

pub fn recv<V: 'static>(&mut self, queue: QueueId<V>) -> Option<V>

Pops the first value from the queue. It returns None if the queue is empty.

pub fn len<V: 'static>(&mut self, queue: QueueId<V>) -> usize

Checks the number of elements in the queue.

Trait Implementations

impl Default for State

fn default() -> Self

Returns the "default value" for a type.