Skip to main content

EnvHandle

Struct EnvHandle 

Source
pub struct EnvHandle { /* private fields */ }
Expand description

A lightweight handle to the simulation environment, intended to be cloned and passed into spawned processes.

Both SimEnv and all EnvHandle clones share the same underlying SimState and the same RandomSource.

Implementations§

Source§

impl EnvHandle

Source

pub fn now(&self) -> f64

Current simulation time.

Source

pub fn rng(&self) -> impl RngCore + '_

Borrow the shared RNG mutably.

The returned guard implements rand::RngCore, so it works with the rng::sample transforms and with rand_distr distributions alike. Sample before awaiting — the guard cannot be held across an .await point.

use simu::{SimEnv, rng::sample};
let env = SimEnv::with_seed(0);
let h = env.handle();
let duration = sample::exponential(&mut h.rng(), 20.0); // mean = 20
assert!(duration >= 0.0);
Source

pub fn timeout(&self, delay: f64) -> Timeout

Create a Timeout that resolves after delay simulated time units.

The deadline is computed when the Timeout is created (now() + delay), not when it is first awaited — relevant when a Timeout is stored and raced later inside any_of!.

§Panics

Panics if delay is negative or not finite (NaN / infinity). Simulated time is monotonic, so a negative delay is a programming error; a zero delay is allowed and fires on the next event-loop iteration.

Source

pub fn event(&self) -> (EventTrigger, EventAwaitable)

Create a paired (EventTrigger, EventAwaitable) for inter-process signalling.

Source

pub fn spawn<F>(&self, future: F) -> ProcessHandle<F::Output>
where F: Future + 'static, F::Output: 'static,

Spawn a child process from within a running process.

Returns a ProcessHandle that resolves to the process’s output when it finishes. Drop the handle to detach (fire-and-forget).

Trait Implementations§

Source§

impl Clone for EnvHandle

Source§

fn clone(&self) -> EnvHandle

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EnvHandle

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V