summary refs log tree commit diff
path: root/src/libstd/process.rs
diff options
context:
space:
mode:
authorCorey Farwell <coreyf@rwell.org>2016-07-12 19:52:44 -0400
committerCorey Farwell <coreyf@rwell.org>2016-07-12 21:32:55 -0400
commit27e44edb4c496b473c92851a100fe084a8f760a6 (patch)
tree3c09a8007c43d4def59d62db66a45fbc070c7261 /src/libstd/process.rs
parent3085ec78487712ed77a506d9cba8d69cd3a44684 (diff)
downloadrust-27e44edb4c496b473c92851a100fe084a8f760a6.tar.gz
rust-27e44edb4c496b473c92851a100fe084a8f760a6.zip
Add doc example for `std::process::ExitStatus::success`.
Diffstat (limited to 'src/libstd/process.rs')
-rw-r--r--src/libstd/process.rs17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/libstd/process.rs b/src/libstd/process.rs
index 16bc81de78e..660c098d30b 100644
--- a/src/libstd/process.rs
+++ b/src/libstd/process.rs
@@ -605,6 +605,23 @@ pub struct ExitStatus(imp::ExitStatus);
 impl ExitStatus {
     /// Was termination successful? Signal termination not considered a success,
     /// and success is defined as a zero exit status.
+    ///
+    /// # Examples
+    ///
+    /// ```rust,no_run
+    /// use std::process::Command;
+    ///
+    /// let status = Command::new("mkdir")
+    ///                      .arg("projects")
+    ///                      .status()
+    ///                      .expect("failed to execute mkdir");
+    ///
+    /// if status.success() {
+    ///     println!("'projects/' directory created");
+    /// } else {
+    ///     println!("failed to create 'projects/' directory");
+    /// }
+    /// ```
     #[stable(feature = "process", since = "1.0.0")]
     pub fn success(&self) -> bool {
         self.0.success()