Struct Process 

pub struct Process { /* private fields */ }

The Process class facilitating execution of a Child Process in Node.js or NWJS environments. This wrapper runs the child process as a daemon, restarting it if it fails. The process provides stdout and stderr output as channel Receiver channels, allowing for a passive capture of the process console output.

Implementations

impl Process

pub fn new(options: Options) -> Process

Create new process instance

pub fn new_once(path: &str) -> Process

Creates a Process that runs the executable at path a single time (no automatic restart) with default options.

pub async fn version(path: &str) -> Result<Version>

Runs the executable at path with --version and parses the resulting Version.

pub fn is_running(&self) -> bool

Returns true if the child process is currently running.

pub fn mute(&self, mute: bool) -> Result<()>

Enables or disables muting of the process stdout/stderr output relay.

pub fn toggle_mute(&self) -> Result<bool>

Toggles muting of the process output buffer, returning the new mute state.

pub fn uptime(&self) -> Option<Duration>

Returns how long the process has been running, or None if it is not running.

pub fn events(&self) -> Receiver<Event>

Obtain a clone of the channel Receiver that captures Event of the underlying process.

pub fn replace_argv(&self, argv: Vec<String>)

Replace the process arguments used for the next process (re)start.

pub fn run(&self) -> Result<()>

Run the process in the background. Spawns an async task that monitors the process, capturing its output and restarting the process if it exits prematurely.

pub fn kill(&self) -> Result<()>

Issue a SIGKILL signal, terminating the process immediately.

pub fn restart(&self) -> Result<()>

Issue a SIGTERM signal causing the process to exit. The process will be restarted by the monitoring task.

pub fn stop(&self) -> Result<()>

Stop the process by disabling auto-restart and issuing a SIGTERM signal. Returns Ok(()) if the process is not running.

pub async fn join(&self) -> Result<()>

Join the process like you would a thread - this async function blocks until the process exits.

pub async fn stop_and_join(&self) -> Result<()>

Stop the process and block until it exits.

Trait Implementations

impl Clone for Process

fn clone(&self) -> Process

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Send for Process

impl Sync for Process