Enum watchexec::command::Process

pub enum Process {
    None,
    Grouped(AsyncGroupChild),
    Ungrouped(Child),
    Done(ExitStatus),
}

Low-level wrapper around a process child, be it grouped or ungrouped.

Variants

None

The initial state of the process, before it’s spawned.

Grouped(AsyncGroupChild)

A grouped process that’s been spawned.

Ungrouped(Child)

An ungrouped process that’s been spawned.

Done(ExitStatus)

The cached exit status of the process.

Implementations

impl Process

pub fn signal(&mut self, sig: Signal) -> Result<(), RuntimeError>

Sends a Unix signal to the process.

Does nothing if the process is not running.

pub async fn kill(&mut self) -> Result<(), RuntimeError>

Kills the process.

Does nothing if the process is not running.

Note that this has different behaviour for grouped and ungrouped processes due to Tokio’s API: it waits on ungrouped processes, but not for grouped processes.

pub fn is_running(&mut self) -> Result<bool, RuntimeError>

Checks the status of the process.

Returns true if the process is still running.

This takes &mut self as it transitions the Process state to Process::Done if it finds the process has ended, such that it will cache the exit status. Otherwise that status would be lost.

Does nothing and returns false immediately if the Process is Done or None.

pub async fn wait(&mut self) -> Result<Option<ExitStatus>, RuntimeError>

Waits for the process to exit, and returns its exit status.

This takes &mut self as it transitions the Process state to Process::Done if it finds the process has ended, such that it will cache the exit status.

This makes it possible to call wait on a process multiple times, without losing the exit status.

Returns immediately with the cached exit status if the Process is Done, and with None if the Process is None.

Trait Implementations

impl Debug for Process

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

Formats the value using the given formatter.

impl Default for Process

fn default() -> Self

Returns Process::None.