Skip to main content

Module control

Module control 

Source
Expand description

Cancellation and progress shared between an analysis and its front end.

The library never prints or draws: it updates lock-free counters that the CLI (progress bars) and the GUI (progress panel) poll, and it checks a cancellation flag at every record, batch and finalised position.

Structs§

Hook
A function a front end has the analysis run at a given moment. It must return promptly.
ProbeFacts
What the first batch of an input shows, computed by one function for the pre-check and the run (validation::probe_facts), so the two can be compared exactly (D108).
Progress
Progress counters, updated by the library and read by front ends at any time.
ProgressSnapshot
A consistent-enough copy of the progress counters.
RunControl
Cancellation, progress and threading for one analysis.

Enums§

Phase
Phases of an analysis, in order.