Struct Stop 

pub struct Stop { /* private fields */ }

A cooperative stop, shared with whoever asked the loop to run.

Cloning is how the request travels: serve_until keeps one handle, the Ctrl-C listener and the web UI keep others, and every clone points at the same flag. There is no channel because there is nothing to send — the only message is “stop”, it is idempotent, and a flag cannot be missed by a receiver that was not listening yet.

The handle also answers the question the operator’s screen asks next: a stop does not take effect until the run in flight has finished, so Stop::finishing reports “asked to stop, still working” rather than leaving a caller to infer it from a heartbeat and hope.

Implementations

impl Stop

pub fn new() -> Self

A stop nobody has asked for yet.

pub fn stop(&self)

Ask the loop to stop. Idempotent, and safe to call before the loop starts: the flag is checked before the first poll.

pub fn stopped(&self) -> bool

Has a stop been asked for?

pub fn finishing(&self) -> bool

Has a stop been asked for that has not taken effect yet, because a run is still in flight?

This is the state a screen has to be able to show. A stop never abandons a run — see serve_until — so between the tap and the loop’s return there is a window of tens of minutes in which “running” and “stopped” are both misleading answers.

pub fn park(&self)

Ask the loop to stop and the run in flight to park at its next node boundary.

The plain Stop::stop never abandons a run, which is right when the operator only wants the queue to drain: a competition is tens of minutes and its worktrees are paid for. But an operator who wants to replace the binary cannot wait out a run that has an hour left, and killing the process loses whatever the seats in flight had not written. Parking costs at most the node in progress and leaves the run resumable.

pub fn parking(&self) -> bool

Has a park been asked for?

pub fn pause(&self) -> Pause

The pause handle to give a runner.

pub fn busy_now(&self) -> bool

Is any run in flight right now?

finishing answers “a stop is waiting on a run”, which is false until someone asks to stop. An upgrade needs the plain question, because it is about to be the one asking.

Trait Implementations

impl Clone for Stop

fn clone(&self) -> Stop

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Stop

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

Formats the value using the given formatter.

impl Default for Stop

fn default() -> Stop

Returns the “default value” for a type.