Struct RunControl 

pub struct RunControl { /* private fields */ }

Collaborative drain control for graceful shutdown

Allows requesting that the graph stop at the next superstep boundary after saving a checkpoint.

Implementations

impl RunControl

pub fn new() -> Self

Create a new run control

pub fn request_drain(&self, reason: &str)

Request that execution drain at next superstep boundary

Arguments

• reason - Reason for the drain request

Panics

Panics if the internal mutex is poisoned (indicates a programming error).

pub fn drain_requested(&self) -> bool

Check if drain has been requested

Panics

Panics if the internal mutex is poisoned (indicates a programming error).

pub fn drain_reason(&self) -> Option<String>

Get the drain reason if set

Panics

Panics if the internal mutex is poisoned (indicates a programming error).

Trait Implementations

impl Clone for RunControl

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunControl

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

Formats the value using the given formatter.

impl Default for RunControl

fn default() -> Self

Returns the “default value” for a type.