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

process: fix some docs (#2843)

Browse Source 
* fix docs for Command::status and output

Co-authored-by: Alice Ryhl <[email protected]>
This commit is contained in:
Nylonicious
2020-09-18 22:49:13 +00:00
committed by GitHub
co-authored by Alice Ryhl
parent 3fd043931e
commit 207320dbbb
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio/src/process/mod.rs
+11 -5
View File
@@ -103,7 +103,7 @@
//! paradigm of dropping-implies-cancellation, a spawned process will, by //! paradigm of dropping-implies-cancellation, a spawned process will, by
//! default, continue to execute even after the `Child` handle has been dropped. //! default, continue to execute even after the `Child` handle has been dropped.
//! //!
//! The `Command::kill_on_drop` method can be used to modify this behavior //! The [`Command::kill_on_drop`] method can be used to modify this behavior
//! and kill the child process if the `Child` wrapper is dropped before it //! and kill the child process if the `Child` wrapper is dropped before it
//! has exited. //! has exited.
//! //!
@@ -581,8 +581,10 @@ impl Command {
/// All I/O this child does will be associated with the current default /// All I/O this child does will be associated with the current default
/// event loop. /// event loop.
/// ///
/// If this future is dropped before the future resolves, then /// The destructor of the future returned by this function will kill
/// the child will be killed, if it was spawned. /// the child if [`kill_on_drop`] is set to true.
///
/// [`kill_on_drop`]: fn@Self::kill_on_drop
/// ///
/// # Errors /// # Errors
/// ///
@@ -602,6 +604,7 @@ impl Command {
/// .await /// .await
/// .expect("ls command failed to run") /// .expect("ls command failed to run")
/// } /// }
/// ```
pub fn status(&mut self) -> impl Future<Output = io::Result<ExitStatus>> { pub fn status(&mut self) -> impl Future<Output = io::Result<ExitStatus>> {
let child = self.spawn(); let child = self.spawn();
@@ -637,8 +640,10 @@ impl Command {
/// All I/O this child does will be associated with the current default /// All I/O this child does will be associated with the current default
/// event loop. /// event loop.
/// ///
/// If this future is dropped before the future resolves, then /// The destructor of the future returned by this function will kill
/// the child will be killed, if it was spawned. /// the child if [`kill_on_drop`] is set to true.
///
/// [`kill_on_drop`]: fn@Self::kill_on_drop
/// ///
/// # Examples /// # Examples
/// ///
@@ -654,6 +659,7 @@ impl Command {
/// .expect("ls command failed to run"); /// .expect("ls command failed to run");
/// println!("stderr of ls: {:?}", output.stderr); /// println!("stderr of ls: {:?}", output.stderr);
/// } /// }
/// ```
pub fn output(&mut self) -> impl Future<Output = io::Result<Output>> { pub fn output(&mut self) -> impl Future<Output = io::Result<Output>> {
self.std.stdout(Stdio::piped()); self.std.stdout(Stdio::piped());
self.std.stderr(Stdio::piped()); self.std.stderr(Stdio::piped());