pub struct Command { /* fields omitted */ }
A process builder, providing fine-grained control over how a new process should be spawned.
A default configuration can be generated using Command::new(program)
, where program
gives a path to the program to be executed. Additional builder methods allow the configuration to be changed (for example, by adding arguments) prior to spawning:
use std::process::Command; let output = if cfg!(target_os = "windows") { Command::new("cmd") .args(&["/C", "echo hello"]) .output() .expect("failed to execute process") } else { Command::new("sh") .arg("-c") .arg("echo hello") .output() .expect("failed to execute process") }; let hello = output.stdout;
Command
can be reused to spawn multiple processes. The builder methods change the command without needing to immediately spawn the process.
use std::process::Command; let mut echo_hello = Command::new("sh"); echo_hello.arg("-c") .arg("echo hello"); let hello_1 = echo_hello.output().expect("failed to execute process"); let hello_2 = echo_hello.output().expect("failed to execute process");
Similarly, you can call builder methods after spawning a process and then spawn a new process with the modified settings.
use std::process::Command; let mut list_dir = Command::new("ls"); // Execute `ls` in the current directory of the program. list_dir.status().expect("process failed to execute"); println!(); // Change `ls` to execute in the root directory. list_dir.current_dir("/"); // And then execute `ls` again but in the root directory. list_dir.status().expect("process failed to execute");
impl Command
[src]
pub fn new<S: AsRef<OsStr>>(program: S) -> Command
[src]
Constructs a new Command
for launching the program at path program
, with the following default configuration:
spawn
or status
, but create pipes for output
Builder methods are provided to change these defaults and otherwise configure the process.
If program
is not an absolute path, the PATH
will be searched in an OS-defined way.
The search path to be used may be controlled by setting the PATH
environment variable on the Command, but this has some implementation limitations on Windows (see issue #37519).
Basic usage:
use std::process::Command; Command::new("sh") .spawn() .expect("sh command failed to start");
pub fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Command
[src]
Adds an argument to pass to the program.
Only one argument can be passed per use. So instead of:
.arg("-C /path/to/repo")
usage would be:
.arg("-C") .arg("/path/to/repo")
To pass multiple arguments see args
.
Basic usage:
use std::process::Command; Command::new("ls") .arg("-l") .arg("-a") .spawn() .expect("ls command failed to start");
pub fn args<I, S>(&mut self, args: I) -> &mut Command where
I: IntoIterator<Item = S>,
S: AsRef<OsStr>,
[src]
Adds multiple arguments to pass to the program.
To pass a single argument see arg
.
Basic usage:
use std::process::Command; Command::new("ls") .args(&["-l", "-a"]) .spawn() .expect("ls command failed to start");
pub fn env<K, V>(&mut self, key: K, val: V) -> &mut Command where
K: AsRef<OsStr>,
V: AsRef<OsStr>,
[src]
Inserts or updates an environment variable mapping.
Note that environment variable names are case-insensitive (but case-preserving) on Windows, and case-sensitive on all other platforms.
Basic usage:
use std::process::Command; Command::new("ls") .env("PATH", "/bin") .spawn() .expect("ls command failed to start");
pub fn envs<I, K, V>(&mut self, vars: I) -> &mut Command where
I: IntoIterator<Item = (K, V)>,
K: AsRef<OsStr>,
V: AsRef<OsStr>,
[src]1.19.0
Adds or updates multiple environment variable mappings.
Basic usage:
use std::process::{Command, Stdio}; use std::env; use std::collections::HashMap; let filtered_env : HashMap<String, String> = env::vars().filter(|&(ref k, _)| k == "TERM" || k == "TZ" || k == "LANG" || k == "PATH" ).collect(); Command::new("printenv") .stdin(Stdio::null()) .stdout(Stdio::inherit()) .env_clear() .envs(&filtered_env) .spawn() .expect("printenv failed to start");
pub fn env_remove<K: AsRef<OsStr>>(&mut self, key: K) -> &mut Command
[src]
Removes an environment variable mapping.
Basic usage:
use std::process::Command; Command::new("ls") .env_remove("PATH") .spawn() .expect("ls command failed to start");
pub fn env_clear(&mut self) -> &mut Command
[src]
Clears the entire environment map for the child process.
Basic usage:
use std::process::Command; Command::new("ls") .env_clear() .spawn() .expect("ls command failed to start");
pub fn current_dir<P: AsRef<Path>>(&mut self, dir: P) -> &mut Command
[src]
Sets the working directory for the child process.
If the program path is relative (e.g., "./script.sh"
), it's ambiguous whether it should be interpreted relative to the parent's working directory or relative to current_dir
. The behavior in this case is platform specific and unstable, and it's recommended to use canonicalize
to get an absolute program path instead.
Basic usage:
use std::process::Command; Command::new("ls") .current_dir("/bin") .spawn() .expect("ls command failed to start");
pub fn stdin<T: Into<Stdio>>(&mut self, cfg: T) -> &mut Command
[src]
Configuration for the child process's standard input (stdin) handle.
Defaults to inherit
when used with spawn
or status
, and defaults to piped
when used with output
.
Basic usage:
use std::process::{Command, Stdio}; Command::new("ls") .stdin(Stdio::null()) .spawn() .expect("ls command failed to start");
pub fn stdout<T: Into<Stdio>>(&mut self, cfg: T) -> &mut Command
[src]
Configuration for the child process's standard output (stdout) handle.
Defaults to inherit
when used with spawn
or status
, and defaults to piped
when used with output
.
Basic usage:
use std::process::{Command, Stdio}; Command::new("ls") .stdout(Stdio::null()) .spawn() .expect("ls command failed to start");
pub fn stderr<T: Into<Stdio>>(&mut self, cfg: T) -> &mut Command
[src]
Configuration for the child process's standard error (stderr) handle.
Defaults to inherit
when used with spawn
or status
, and defaults to piped
when used with output
.
Basic usage:
use std::process::{Command, Stdio}; Command::new("ls") .stderr(Stdio::null()) .spawn() .expect("ls command failed to start");
pub fn spawn(&mut self) -> Result<Child>
[src]
Executes the command as a child process, returning a handle to it.
By default, stdin, stdout and stderr are inherited from the parent.
Basic usage:
use std::process::Command; Command::new("ls") .spawn() .expect("ls command failed to start");
pub fn output(&mut self) -> Result<Output>
[src]
Executes the command as a child process, waiting for it to finish and collecting all of its output.
By default, stdout and stderr are captured (and used to provide the resulting output). Stdin is not inherited from the parent and any attempt by the child process to read from the stdin stream will result in the stream immediately closing.
use std::process::Command; use std::io::{self, Write}; let output = Command::new("/bin/cat") .arg("file.txt") .output() .expect("failed to execute process"); println!("status: {}", output.status); io::stdout().write_all(&output.stdout).unwrap(); io::stderr().write_all(&output.stderr).unwrap(); assert!(output.status.success());
pub fn status(&mut self) -> Result<ExitStatus>
[src]
Executes a command as a child process, waiting for it to finish and collecting its exit status.
By default, stdin, stdout and stderr are inherited from the parent.
use std::process::Command; let status = Command::new("/bin/cat") .arg("file.txt") .status() .expect("failed to execute process"); println!("process exited with: {}", status); assert!(status.success());
impl CommandExt for Command
[src]
fn uid(&mut self, id: u32) -> &mut Command
[src]
fn gid(&mut self, id: u32) -> &mut Command
[src]
unsafe fn pre_exec<F>(&mut self, f: F) -> &mut Command where
F: FnMut() -> Result<()> + Send + Sync + 'static,
[src]
fn exec(&mut self) -> Error
[src]
fn arg0<S>(&mut self, arg: S) -> &mut Command where
S: AsRef<OsStr>,
[src]
fn before_exec<F>(&mut self, f: F) -> &mut Command where
F: FnMut() -> Result<()> + Send + Sync + 'static,
[src]1.15.0
impl CommandExt for Command
[src]1.16.0
fn creation_flags(&mut self, flags: u32) -> &mut Command
[src]
impl Debug for Command
[src]
impl !RefUnwindSafe for Command
impl Send for Command
impl Sync for Command
impl Unpin for Command
impl !UnwindSafe for Command
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
fn borrow(&self) -> &TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/process/struct.Command.html