From 27e44edb4c496b473c92851a100fe084a8f760a6 Mon Sep 17 00:00:00 2001 From: Corey Farwell Date: Tue, 12 Jul 2016 19:52:44 -0400 Subject: [PATCH] Add doc example for `std::process::ExitStatus::success`. --- src/libstd/process.rs | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/libstd/process.rs b/src/libstd/process.rs index 16bc81de78ecf..660c098d30bc2 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()