Skip to main content

Executor

Struct Executor 

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

The executor (design-doc §4.3). !Send — it never leaves the sim thread.

Implementations§

Source§

impl Executor

Source

pub fn spawn_named<F>( &self, fut: F, name: Option<&str>, ) -> TaskHandle<F::Output>
where F: Future + 'static,

Source

pub fn run_until_idle(&self)

Drain the run queue to exhaustion, then return to the simulator. Port of EventLoop.run (cocotb: _event_loop.py).

Source

pub fn cancel(&self, id: TaskId)

Cancel = drop the future (design-doc §4.6). Cleanup happens in Drop impls; there is no exception to catch.

Source

pub fn cancel_after(&self, watermark: TaskId)

Cancel every live task with id >= watermark (the snapshot taken before the test spawned anything) — the runner uses this to kill a test’s surviving tasks at test end (design-doc §4.5).

Source

pub fn watermark(&self) -> TaskId

Current high-water task id (snapshot before starting a test).

Source

pub fn set_failure_sink(&self, f: Box<dyn Fn(&str)>)

Source

pub fn live_tasks(&self) -> usize

Trait Implementations§

Source§

impl Clone for Executor

Source§

fn clone(&self) -> Executor

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

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> 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.