OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

std: Fixup docs for std::process

Browse Source
This commit is contained in:
tynopex 2015-04-29 17:00:10 -04:00
parent 551a74dddd
commit cf053d72a0
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/libstd/process.rs
View File

@ -40,11 +40,15 @@ use thread;
/// ```should_panic /// ```should_panic
/// use std::process::Command; /// use std::process::Command;
/// ///
/// let output = Command::new("/bin/cat").arg("file.txt").output().unwrap_or_else(|e| { /// let mut child = Command::new("/bin/cat")
/// panic!("failed to execute child: {}", e) /// .arg("file.txt")
/// }); /// .spawn()
/// let contents = output.stdout; /// .unwrap_or_else(|e| { panic!("failed to execute child: {}", e) });
/// assert!(output.status.success()); ///
/// let ecode = child.wait()
/// .unwrap_or_else(|e| { panic!("failed to wait on child: {}", e) });
///
/// assert!(ecode.success());
/// ``` /// ```
#[stable(feature = "process", since = "1.0.0")] #[stable(feature = "process", since = "1.0.0")]
pub struct Child { pub struct Child {
@ -118,9 +122,11 @@ impl Read for ChildStderr {
/// ``` /// ```
/// use std::process::Command; /// use std::process::Command;
/// ///
/// let output = Command::new("sh").arg("-c").arg("echo hello").output().unwrap_or_else(|e| { /// let output = Command::new("sh")
/// panic!("failed to execute process: {}", e) /// .arg("-c")
/// }); /// .arg("echo hello")
/// .output()
/// .unwrap_or_else(|e| { panic!("failed to execute process: {}", e) });
/// let hello = output.stdout; /// let hello = output.stdout;
/// ``` /// ```
#[stable(feature = "process", since = "1.0.0")] #[stable(feature = "process", since = "1.0.0")]
@ -140,7 +146,7 @@ impl Command {
/// * No arguments to the program /// * No arguments to the program
/// * Inherit the current process's environment /// * Inherit the current process's environment
/// * Inherit the current process's working directory /// * Inherit the current process's working directory
/// * Inherit stdin/stdout/stderr for `run` or `status`, but create pipes for `output` /// * Inherit stdin/stdout/stderr for `spawn` or `status`, but create pipes for `output`
/// ///
/// Builder methods are provided to change these defaults and /// Builder methods are provided to change these defaults and
/// otherwise configure the process. /// otherwise configure the process.
@ -202,7 +208,6 @@ impl Command {
} }
/// Configuration for the child process's stdin handle (file descriptor 0). /// Configuration for the child process's stdin handle (file descriptor 0).
/// Defaults to `CreatePipe(true, false)` so the input can be written to.
#[stable(feature = "process", since = "1.0.0")] #[stable(feature = "process", since = "1.0.0")]
pub fn stdin(&mut self, cfg: Stdio) -> &mut Command { pub fn stdin(&mut self, cfg: Stdio) -> &mut Command {
self.stdin = Some(cfg.0); self.stdin = Some(cfg.0);
@ -210,7 +215,6 @@ impl Command {
} }
/// Configuration for the child process's stdout handle (file descriptor 1). /// Configuration for the child process's stdout handle (file descriptor 1).
/// Defaults to `CreatePipe(false, true)` so the output can be collected.
#[stable(feature = "process", since = "1.0.0")] #[stable(feature = "process", since = "1.0.0")]
pub fn stdout(&mut self, cfg: Stdio) -> &mut Command { pub fn stdout(&mut self, cfg: Stdio) -> &mut Command {
self.stdout = Some(cfg.0); self.stdout = Some(cfg.0);
@ -218,7 +222,6 @@ impl Command {
} }
/// Configuration for the child process's stderr handle (file descriptor 2). /// Configuration for the child process's stderr handle (file descriptor 2).
/// Defaults to `CreatePipe(false, true)` so the output can be collected.
#[stable(feature = "process", since = "1.0.0")] #[stable(feature = "process", since = "1.0.0")]
pub fn stderr(&mut self, cfg: Stdio) -> &mut Command { pub fn stderr(&mut self, cfg: Stdio) -> &mut Command {
self.stderr = Some(cfg.0); self.stderr = Some(cfg.0);
@ -356,7 +359,7 @@ pub struct Output {
pub stderr: Vec<u8>, pub stderr: Vec<u8>,
} }
/// Describes what to do with a standard io stream for a child process. /// Describes what to do with a standard I/O stream for a child process.
#[stable(feature = "process", since = "1.0.0")] #[stable(feature = "process", since = "1.0.0")]
pub struct Stdio(StdioImp); pub struct Stdio(StdioImp);