Struct Run 

pub struct Run { /* private fields */ }

A set of root planners advanced by its caller on one thread at a time.

Dropping a run clears the IO session of every root still live, even when it ends in an error.

Implementations

impl Run

pub fn new() -> Self

Creates a run with nothing admitted.

pub fn with_step_limit(self, steps: usize) -> Self

Fails with an error naming the limit if more than steps visits are needed. Tests use it to catch loops.

pub fn admit( &mut self, root: Box<dyn Planner>, scope: WorkScope, io: Arc<dyn IoSource>, ) -> RootId

Admits root and everything it spawns, reading through io.

The session belongs to the root: the run submits the requests of every descendant to it, and clears it once they have all retired or the root is cancelled.

pub fn cancel(&mut self, root: RootId)

Drops every live item descended from root and clears its session. Batches the root already produced are still returned, followed by no Progress::RootDone.

pub fn live_roots(&self) -> usize

The number of admitted roots that have not finished.

pub fn advance(&mut self) -> VortexResult<Progress>

Runs ready work, taking completions the sources already have, until there is something to hand back or everything left waits for IO. Never blocks.

pub fn complete(&mut self, completion: Completion) -> VortexResult<()>

Delivers a completion taken from the session of one of the run’s roots.

pub fn poll_completion( &mut self, cx: &mut Context<'_>, ) -> Poll<VortexResult<()>>

Waits for a completion from any root’s session, registering cx to be woken by the next one, and delivers every completion that is ready.

Call it after advance returned Progress::Waiting.

Trait Implementations

impl Default for Run

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Run

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.