about summary refs log tree commit diff
path: root/src/libstd/process.rs
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume1.gomez@gmail.com>2016-07-15 10:56:43 +0200
committerGitHub <noreply@github.com>2016-07-15 10:56:43 +0200
commit367f942ce483ce0f8b858d3e31d55dd3cbf070cb (patch)
tree514cb2b7bccbce0ffe6e1539472d7b73172c8a5d /src/libstd/process.rs
parentd607e284c820bb9c2db7d11c6fa65a4138b4afb0 (diff)
parent27e44edb4c496b473c92851a100fe084a8f760a6 (diff)
downloadrust-367f942ce483ce0f8b858d3e31d55dd3cbf070cb.tar.gz
rust-367f942ce483ce0f8b858d3e31d55dd3cbf070cb.zip
Rollup merge of #34794 - frewsxcv:exitstatus-success, r=GuillaumeGomez
Add doc example for `std::process::ExitStatus::success`.

None
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()