Simulator

Struct Simulator 

Source
pub struct Simulator<C>(/* private fields */);
Expand description

The principal driver of a simulation run which can be initialized using a configuration.

Implementations§

Source§

impl<C> Simulator<C>

Source

pub const fn new(config: C) -> Self

Creates a new simulator from a configuration.

Source

pub fn into_inner(self) -> C

Converts the simulator back into a configuration.

Source

pub fn inner(&self) -> &C

Grants shared access to the inner configuration.

Source

pub fn inner_mut(&mut self) -> &mut C

Grants mutable access to the inner configuration.

Source§

impl<C: Config> Simulator<C>

Source

pub fn run<F, R>(&self, main: F) -> Result<R, Deadlock<C::Time>>
where F: AsyncFnOnce(&Sim<C>) -> R,

Executes the simulation model provided in the closure and returns its result in the Ok-variant of a Result.

The Err-variant is reserved for errors that occur during the event-loop. Only a Deadlock can be reported.

Source

pub fn with_result<F, T, E>(&self, main: F) -> Result<T, E>
where F: AsyncFnOnce(&Sim<C>) -> Result<T, E>, E: From<Deadlock<C::Time>>,

Executes the simulation model provided in the closure that has to return a Result.

The result of a simulation run can also be a Deadlock if the scheduler detects that it is not possible to schedule any more continuations after some model-time has passed.

Trait Implementations§

Source§

impl<C: Clone> Clone for Simulator<C>

Source§

fn clone(&self) -> Simulator<C>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<C: Default> Default for Simulator<C>

Source§

fn default() -> Simulator<C>

Returns the “default value” for a type. Read more
Source§

impl<C> From<C> for Simulator<C>

Source§

fn from(config: C) -> Self

Converts to this type from the input type.
Source§

impl<C: Copy> Copy for Simulator<C>

Auto Trait Implementations§

§

impl<C> Freeze for Simulator<C>
where C: Freeze,

§

impl<C> RefUnwindSafe for Simulator<C>
where C: RefUnwindSafe,

§

impl<C> Send for Simulator<C>
where C: Send,

§

impl<C> Sync for Simulator<C>
where C: Sync,

§

impl<C> Unpin for Simulator<C>
where C: Unpin,

§

impl<C> UnwindSafe for Simulator<C>
where C: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<!> for T

Source§

fn from(t: !) -> T

Converts to this type from the input type.
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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