Struct Machine 

pub struct Machine {
    pub name: String,
    pub doc: u64,
    pub inputs: Vec<Bound>,
    pub output: Option<Place>,
    pub executed: u64,
    pub time_limit_ms: f64,
    pub dry_run: bool,
    pub stopped: Option<(String, bool)>,
    pub partial: Option<(String, String)>,
    pub last_params: Option<Value>,
    pub wrote_files: Vec<String>,
    /* private fields */
}

A macro run in progress: which step is next, and what has run.

Fields

name: String

doc: u64

inputs: Vec<Bound>

output: Option<Place>

executed: u64

Steps executed so far (each pass through a Repeat counts).

time_limit_ms: f64

dry_run: bool

Dry run (the footprint check): steps that would touch files or can’t be previewed stop the run early instead of running.

stopped: Option<(String, bool)>

A Stop step ended the run: its message, and whether it asked for a rollback.

partial: Option<(String, String)>

A dry run stopped before this step (path, reason): what follows isn’t in the footprint.

last_params: Option<Value>

The last step’s resolved parameters (for the debugger).

wrote_files: Vec<String>

Files the run wrote (“step 1 (file.exportCsv)”): rolling the run back doesn’t take them back.

Implementations

impl Machine

pub fn new(p: &Prepared, dry_run: bool) -> Machine

pub fn is_done(&self) -> bool

pub fn restart_clock(&mut self)

Starts the time limit again (the debugger gives each action its own).

pub fn current_json(&self, wb: &Workbook) -> Json

The current step for the debugger: its path, kind, command, parameters as they would run now, and the Repeat pass.

pub fn current(&self) -> Option<(String, &Step)>

The step that runs next, with its path.

pub fn iteration(&self) -> Option<(u32, u32)>

The innermost Repeat’s pass (1-based) and count.

pub fn run_to_end(&mut self, s: &mut Session) -> Result<(), StepError>

Runs every remaining step.

pub fn step(&mut self, s: &mut Session) -> Result<(), StepError>

Runs the current step and moves to the next one.

Trait Implementations

impl Clone for Machine

fn clone(&self) -> Machine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Machine

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

Formats the value using the given formatter.