Struct ProcessSpec 

pub struct ProcessSpec { /* private fields */ }

Description of a native child process to run and stream.

Implementations

impl ProcessSpec

pub fn new(program: impl Into<Arc<str>>) -> Self

Create a process spec for program.

pub fn arg(self, arg: impl Into<Arc<str>>) -> Self

Append a single argument.

pub fn args<I, S>(self, args: I) -> Self

where I: IntoIterator<Item = S>, S: Into<Arc<str>>,

Append multiple arguments.

pub fn cwd(self, cwd: impl Into<PathBuf>) -> Self

Set the child process working directory.

pub fn env(self, key: impl Into<Arc<str>>, value: impl Into<Arc<str>>) -> Self

Set an environment variable for the child process.

pub fn stdin(self, stdin: impl Into<Vec<u8>>) -> Self

Provide bytes to write to the child process stdin, then close stdin.

pub fn program(&self) -> &str

Program executable name or path.

pub fn args_slice(&self) -> &[Arc<str>]

Process arguments.

pub fn cwd_path(&self) -> Option<&Path>

Working directory, when configured.

pub fn env_slice(&self) -> &[(Arc<str>, Arc<str>)]

Environment overrides.

pub fn stdin_bytes(&self) -> Option<&[u8]>

Bytes that will be written to stdin, when configured.

pub fn stream(self, emit: impl FnMut(ProcessEvent)) -> Result<()>

Run the process on the current thread and emit streaming events.

Stdout and stderr are drained on separate helper threads so a child that writes heavily to both streams cannot deadlock on a full pipe.

pub fn command<Msg, F>(self, map: F) -> Command

where Msg: Send + 'static, F: Fn(ProcessEvent) -> Msg + Send + 'static,

Create an unkeyed background Command that streams process events as messages.

Unkeyed commands do not have a normal runtime coalescing/cancellation owner. Use Self::command_keyed when newer work should cancel an active process.

pub fn command_keyed<Msg, F>( self, key: impl Into<Arc<str>>, policy: TaskPolicy, map: F, ) -> Command

where Msg: Send + 'static, F: Fn(ProcessEvent) -> Msg + Send + 'static,

Create a keyed background Command that streams process events as messages.

With TaskPolicy::LatestOnly, submitting newer work for the same key cancels the active token. This helper observes that token, kills the child process, drains stdout/stderr, and suppresses stale messages.

Trait Implementations

impl Clone for ProcessSpec

fn clone(&self) -> ProcessSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessSpec

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

Formats the value using the given formatter.

impl Eq for ProcessSpec

impl PartialEq for ProcessSpec

fn eq(&self, other: &ProcessSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ProcessSpec