]> git.lizzy.rs Git - rust.git/commitdiff
Add doc example for `std::process::ExitStatus::success`.
authorCorey Farwell <coreyf@rwell.org>
Tue, 12 Jul 2016 23:52:44 +0000 (19:52 -0400)
committerCorey Farwell <coreyf@rwell.org>
Wed, 13 Jul 2016 01:32:55 +0000 (21:32 -0400)
src/libstd/process.rs

index 16bc81de78ecf6debe8f6371eedf905779e5f3b9..660c098d30bc29d157bfb8888ae6e145482aa152 100644 (file)
@@ -605,6 +605,23 @@ fn from_inner(inner: imp::Stdio) -> Stdio {
 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()