tokio-rs/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2026-09-08 00:00:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

task: clarify process::Command docs (#5406) (#5413)

Browse Source
This commit is contained in:
mTsBucy1
2023-01-30 16:47:04 +01:00
committed by GitHub
parent 88b1eb54fb
commit 80ec80165b
1 changed files with 67 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio/src/process/mod.rs
+67 -28
View File
@@ -309,7 +309,8 @@ impl Command {
/// ///
/// ```no_run /// ```no_run
/// use tokio::process::Command; /// use tokio::process::Command;
/// let command = Command::new("sh"); /// let mut command = Command::new("sh");
/// # let _ = command.output(); // assert borrow checker
/// ``` /// ```
/// ///
/// [rust-lang/rust#37519]: https://github.com/rust-lang/rust/issues/37519 /// [rust-lang/rust#37519]: https://github.com/rust-lang/rust/issues/37519
@@ -328,16 +329,20 @@ impl Command {
/// Only one argument can be passed per use. So instead of: /// Only one argument can be passed per use. So instead of:
/// ///
/// ```no_run /// ```no_run
/// tokio::process::Command::new("sh") /// let mut command = tokio::process::Command::new("sh");
/// .arg("-C /path/to/repo"); /// command.arg("-C /path/to/repo");
///
/// # let _ = command.output(); // assert borrow checker
/// ``` /// ```
/// ///
/// usage would be: /// usage would be:
/// ///
/// ```no_run /// ```no_run
/// tokio::process::Command::new("sh") /// let mut command = tokio::process::Command::new("sh");
/// .arg("-C") /// command.arg("-C");
/// .arg("/path/to/repo"); /// command.arg("/path/to/repo");
///
/// # let _ = command.output(); // assert borrow checker
/// ``` /// ```
/// ///
/// To pass multiple arguments see [`args`]. /// To pass multiple arguments see [`args`].
@@ -349,11 +354,15 @@ impl Command {
/// Basic usage: /// Basic usage:
/// ///
/// ```no_run /// ```no_run
/// # async fn test() { // allow using await
/// use tokio::process::Command; /// use tokio::process::Command;
/// ///
/// let command = Command::new("ls") /// let output = Command::new("ls")
/// .arg("-l") /// .arg("-l")
/// .arg("-a"); /// .arg("-a")
/// .output().await.unwrap();
/// # }
///
/// ``` /// ```
pub fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Command { pub fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Command {
self.std.arg(arg); self.std.arg(arg);
@@ -371,10 +380,13 @@ impl Command {
/// Basic usage: /// Basic usage:
/// ///
/// ```no_run /// ```no_run
/// # async fn test() { // allow using await
/// use tokio::process::Command; /// use tokio::process::Command;
/// ///
/// let command = Command::new("ls") /// let output = Command::new("ls")
/// .args(&["-l", "-a"]); /// .args(&["-l", "-a"])
/// .output().await.unwrap();
/// # }
/// ``` /// ```
pub fn args<I, S>(&mut self, args: I) -> &mut Command pub fn args<I, S>(&mut self, args: I) -> &mut Command
where where
@@ -395,10 +407,13 @@ impl Command {
/// Basic usage: /// Basic usage:
/// ///
/// ```no_run /// ```no_run
/// # async fn test() { // allow using await
/// use tokio::process::Command; /// use tokio::process::Command;
/// ///
/// let command = Command::new("ls") /// let output = Command::new("ls")
/// .env("PATH", "/bin"); /// .env("PATH", "/bin")
/// .output().await.unwrap();
/// # }
/// ``` /// ```
pub fn env<K, V>(&mut self, key: K, val: V) -> &mut Command pub fn env<K, V>(&mut self, key: K, val: V) -> &mut Command
where where
@@ -416,6 +431,7 @@ impl Command {
/// Basic usage: /// Basic usage:
/// ///
/// ```no_run /// ```no_run
/// # async fn test() { // allow using await
/// use tokio::process::Command; /// use tokio::process::Command;
/// use std::process::{Stdio}; /// use std::process::{Stdio};
/// use std::env; /// use std::env;
@@ -426,11 +442,13 @@ impl Command {
/// k == "TERM" || k == "TZ" || k == "LANG" || k == "PATH" /// k == "TERM" || k == "TZ" || k == "LANG" || k == "PATH"
/// ).collect(); /// ).collect();
/// ///
/// let command = Command::new("printenv") /// let output = Command::new("printenv")
/// .stdin(Stdio::null()) /// .stdin(Stdio::null())
/// .stdout(Stdio::inherit()) /// .stdout(Stdio::inherit())
/// .env_clear() /// .env_clear()
/// .envs(&filtered_env); /// .envs(&filtered_env)
/// .output().await.unwrap();
/// # }
/// ``` /// ```
pub fn envs<I, K, V>(&mut self, vars: I) -> &mut Command pub fn envs<I, K, V>(&mut self, vars: I) -> &mut Command
where where
@@ -449,10 +467,13 @@ impl Command {
/// Basic usage: /// Basic usage:
/// ///
/// ```no_run /// ```no_run
/// # async fn test() { // allow using await
/// use tokio::process::Command; /// use tokio::process::Command;
/// ///
/// let command = Command::new("ls") /// let output = Command::new("ls")
/// .env_remove("PATH"); /// .env_remove("PATH")
/// .output().await.unwrap();
/// # }
/// ``` /// ```
pub fn env_remove<K: AsRef<OsStr>>(&mut self, key: K) -> &mut Command { pub fn env_remove<K: AsRef<OsStr>>(&mut self, key: K) -> &mut Command {
self.std.env_remove(key); self.std.env_remove(key);
@@ -466,10 +487,13 @@ impl Command {
/// Basic usage: /// Basic usage:
/// ///
/// ```no_run /// ```no_run
/// # async fn test() { // allow using await
/// use tokio::process::Command; /// use tokio::process::Command;
/// ///
/// let command = Command::new("ls") /// let output = Command::new("ls")
/// .env_clear(); /// .env_clear()
/// .output().await.unwrap();
/// # }
/// ``` /// ```
pub fn env_clear(&mut self) -> &mut Command { pub fn env_clear(&mut self) -> &mut Command {
self.std.env_clear(); self.std.env_clear();
@@ -493,10 +517,13 @@ impl Command {
/// Basic usage: /// Basic usage:
/// ///
/// ```no_run /// ```no_run
/// # async fn test() { // allow using await
/// use tokio::process::Command; /// use tokio::process::Command;
/// ///
/// let command = Command::new("ls") /// let output = Command::new("ls")
/// .current_dir("/bin"); /// .current_dir("/bin")
/// .output().await.unwrap();
/// # }
/// ``` /// ```
pub fn current_dir<P: AsRef<Path>>(&mut self, dir: P) -> &mut Command { pub fn current_dir<P: AsRef<Path>>(&mut self, dir: P) -> &mut Command {
self.std.current_dir(dir); self.std.current_dir(dir);
@@ -516,11 +543,14 @@ impl Command {
/// Basic usage: /// Basic usage:
/// ///
/// ```no_run /// ```no_run
/// # async fn test() { // allow using await
/// use std::process::{Stdio}; /// use std::process::{Stdio};
/// use tokio::process::Command; /// use tokio::process::Command;
/// ///
/// let command = Command::new("ls") /// let output = Command::new("ls")
/// .stdin(Stdio::null()); /// .stdin(Stdio::null())
/// .output().await.unwrap();
/// # }
/// ``` /// ```
pub fn stdin<T: Into<Stdio>>(&mut self, cfg: T) -> &mut Command { pub fn stdin<T: Into<Stdio>>(&mut self, cfg: T) -> &mut Command {
self.std.stdin(cfg); self.std.stdin(cfg);
@@ -540,11 +570,14 @@ impl Command {
/// Basic usage: /// Basic usage:
/// ///
/// ```no_run /// ```no_run
/// # async fn test() { // allow using await
/// use tokio::process::Command; /// use tokio::process::Command;
/// use std::process::Stdio; /// use std::process::Stdio;
/// ///
/// let command = Command::new("ls") /// let output = Command::new("ls")
/// .stdout(Stdio::null()); /// .stdout(Stdio::null())
/// .output().await.unwrap();
/// # }
/// ``` /// ```
pub fn stdout<T: Into<Stdio>>(&mut self, cfg: T) -> &mut Command { pub fn stdout<T: Into<Stdio>>(&mut self, cfg: T) -> &mut Command {
self.std.stdout(cfg); self.std.stdout(cfg);
@@ -564,11 +597,14 @@ impl Command {
/// Basic usage: /// Basic usage:
/// ///
/// ```no_run /// ```no_run
/// # async fn test() { // allow using await
/// use tokio::process::Command; /// use tokio::process::Command;
/// use std::process::{Stdio}; /// use std::process::{Stdio};
/// ///
/// let command = Command::new("ls") /// let output = Command::new("ls")
/// .stderr(Stdio::null()); /// .stderr(Stdio::null())
/// .output().await.unwrap();
/// # }
/// ``` /// ```
pub fn stderr<T: Into<Stdio>>(&mut self, cfg: T) -> &mut Command { pub fn stderr<T: Into<Stdio>>(&mut self, cfg: T) -> &mut Command {
self.std.stderr(cfg); self.std.stderr(cfg);
@@ -707,10 +743,13 @@ impl Command {
/// [`tokio::process::Command`]: crate::process::Command /// [`tokio::process::Command`]: crate::process::Command
/// ///
/// ```no_run /// ```no_run
/// # async fn test() { // allow using await
/// use tokio::process::Command; /// use tokio::process::Command;
/// ///
/// let command = Command::new("ls") /// let output = Command::new("ls")
/// .process_group(0); /// .process_group(0)
/// .output().await.unwrap();
/// # }
/// ``` /// ```
#[cfg(unix)] #[cfg(unix)]
#[cfg(tokio_unstable)] #[cfg(tokio_unstable)]