Struct Execution 

pub struct Execution { /* private fields */ }

A running plan. Every method takes &self, and the handle can be shared between threads.

Implementations

impl Execution

pub fn start( plan: &Plan, lib_dir: &Path, this: &Path, options: Options, ) -> Result<(Self, Receiver<ExecutionEvent>), EngineError>

Check the plan’s requirements and start its program, with its history marker. Errors are what keeps it from starting.

pub fn write(&self, bytes: &[u8])

Send keyboard input to the program, as a terminal would: \r for Enter, \x03 for Ctrl-C (which the program sees, unlike stop).

pub fn resize(&self, rows: u16, cols: u16)

Give the terminal a new size; the program is told when it changes.

pub fn stop(&self)

Stop the run. The first request hangs up every process in the run’s process group, as a closing terminal does; a later one, while any of them is still running, kills them.

pub fn stop_requested(&self) -> bool

Whether a stop was requested.

pub fn survivors(&self) -> usize

How many processes of the run are still alive, such as ones that ignored the hangup.

pub fn is_finished(&self) -> bool

Whether the run has ended and been checked: true from just before its Completed or Interrupted event is sent.

pub fn finished(&self) -> Option<Finished>

How the run ended, once it has.

pub fn transcript(&self) -> Vec<u8>

Everything the program has written so far, as the Output events carry it.

pub fn record(&self, log: Option<PathBuf>) -> Result<()>

Write the run’s history record, with a saved log if there is one. Only the first call once the run has ended writes it; dropping the handle writes it without a log if no call did. Until then the history’s marker keeps the outcome, in case HelixForge stops first.

Trait Implementations

impl Drop for Execution

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.