Merge #60 #61 #62

60: Cleanup examples r=matthiasbeyer a=matthiasbeyer

Clean the examples up.

61: Format README r=matthiasbeyer a=matthiasbeyer



62: Remove unnecessary boilerplate from doc examples r=matthiasbeyer a=matthiasbeyer



Co-authored-by: Matthias Beyer <mail@beyermatthias.de>

Author: bors[bot]

README.md

@@ -4,19 +4,28 @@
 [![Released API docs](https://docs.rs/rexpect/badge.svg)](https://docs.rs/rexpect)
 [![Master API docs](https://img.shields.io/badge/docs-master-2f343b.svg)](http://philippkeller.github.io/rexpect)
 
-
-Spawn, control, and respond to expected patterns of child applications and processes, enabling the automation of interactions and testing. Components include:
-- **session**: start a new process and interact with it; primary module of rexpect.
-- **reader**: non-blocking reader, which supports waiting for strings, regex, and EOF.
+Spawn, control, and respond to expected patterns of child applications and
+processes, enabling the automation of interactions and testing. Components
+include:
+
+- **session**: start a new process and interact with it; primary module of
+  rexpect.
+- **reader**: non-blocking reader, which supports waiting for strings, regex,
+  and EOF.
 - **process**: spawn a process in a pty.
 
-The goal is to offer a similar set of functionality as [pexpect](https://pexpect.readthedocs.io/en/stable/overview.html).
+The goal is to offer a similar set of functionality as
+[pexpect](https://pexpect.readthedocs.io/en/stable/overview.html).
 
 ## Maintainers wanted
 
-I have created rexpect as a project to learn rust and linux. But now due to some reasons I haven't used Rust in the past 2 years, so I can't keep up with the latest features/crate dependencies
+I have created rexpect as a project to learn rust and linux. But now due to some
+reasons I haven't used Rust in the past 2 years, so I can't keep up with the
+latest features/crate dependencies
 
-It has become hard now to judge pull requests. If you would be willing to either take over this repo entirely or join in as a maintainer to help evaluate PR please contact me.
+It has become hard now to judge pull requests. If you would be willing to either
+take over this repo entirely or join in as a maintainer to help evaluate PR
+please contact me.
 
 ## Examples
 
@@ -55,24 +64,21 @@ fn do_ftp() -> Result<()> {
     Ok(())
 }
 
-
 fn main() {
     do_ftp().unwrap_or_else(|e| panic!("ftp job failed with {}", e));
 }
 ```
 
 ### Example with bash and reading from programs
 
-
 ```rust
 extern crate rexpect;
 use rexpect::spawn_bash;
 use rexpect::errors::*;
 
-
 fn do_bash() -> Result<()> {
     let mut p = spawn_bash(Some(2000))?;
-    
+
     // case 1: wait until program is done
     p.send_line("hostname")?;
     let hostname = p.read_line()?;
@@ -102,7 +108,6 @@ fn do_bash() -> Result<()> {
 fn main() {
     do_bash().unwrap_or_else(|e| panic!("bash job failed with {}", e));
 }
-
 ```
 
 ### Example with bash and job control
@@ -122,7 +127,6 @@ extern crate rexpect;
 use rexpect::spawn_bash;
 use rexpect::errors::*;
 
-
 fn do_bash_jobcontrol() -> Result<()> {
     let mut p = spawn_bash(Some(1000))?;
     p.execute("ping 8.8.8.8", "bytes of data")?;
@@ -157,7 +161,9 @@ rust stable, beta and nightly on both Linux or Mac.
 ## Design decisions
 
 - use error handling of [error-chain](https://github.com/brson/error-chain)
-- use [nix](https://github.com/nix-rust/nix) (and avoid libc wherever possible) to keep the code safe and clean
-- sadly, `expect` is used in rust too prominently to unwrap `Option`s and `Result`s, use `exp_*` instead
+- use [nix](https://github.com/nix-rust/nix) (and avoid libc wherever possible)
+  to keep the code safe and clean
+- sadly, `expect` is used in rust too prominently to unwrap `Option`s and
+  `Result`s, use `exp_*` instead
 
 Licensed under [MIT License](LICENSE)

examples/bash.rs

@@ -2,7 +2,7 @@ extern crate rexpect;
 use rexpect::error::Error;
 use rexpect::spawn_bash;
 
-fn run() -> Result<(), Error> {
+fn main() -> Result<(), Error> {
     let mut p = spawn_bash(Some(1000))?;
     p.execute("ping 8.8.8.8", "bytes")?;
     p.send_control('z')?;
@@ -18,7 +18,3 @@ fn run() -> Result<(), Error> {
     p.exp_string("packet loss")?;
     Ok(())
 }
-
-fn main() {
-    run().unwrap_or_else(|e| panic!("bash process failed with {}", e));
-}

examples/bash_read.rs

@@ -2,7 +2,7 @@ extern crate rexpect;
 use rexpect::error::Error;
 use rexpect::spawn_bash;
 
-fn run() -> Result<(), Error> {
+fn main() -> Result<(), Error> {
     let mut p = spawn_bash(Some(2000))?;
 
     // case 1: wait until program is done
@@ -33,7 +33,3 @@ fn run() -> Result<(), Error> {
     p.send_control('c')?;
     Ok(())
 }
-
-fn main() {
-    run().unwrap_or_else(|e| panic!("bash process failed with {}", e));
-}

examples/exit_code.rs

@@ -8,7 +8,7 @@ use rexpect::spawn;
 /// cat exited with code 0, all good!
 /// cat exited with code 1
 /// Output (stdout and stderr): cat: /this/does/not/exist: No such file or directory
-fn exit_code_fun() -> Result<(), Error> {
+fn main() -> Result<(), Error> {
     let p = spawn("cat /etc/passwd", Some(2000))?;
     match p.process.wait() {
         Ok(wait::WaitStatus::Exited(_, 0)) => println!("cat exited with code 0, all good!"),
@@ -29,7 +29,3 @@ fn exit_code_fun() -> Result<(), Error> {
 
     Ok(())
 }
-
-fn main() {
-    exit_code_fun().unwrap_or_else(|e| panic!("cat function failed with {}", e));
-}

examples/ftp.rs

@@ -3,7 +3,7 @@ extern crate rexpect;
 use rexpect::error::Error;
 use rexpect::spawn;
 
-fn do_ftp() -> Result<(), Error> {
+fn main() -> Result<(), Error> {
     let mut p = spawn("ftp speedtest.tele2.net", Some(2000))?;
     p.exp_regex("Name \\(.*\\):")?;
     p.send_line("anonymous")?;
@@ -18,7 +18,3 @@ fn do_ftp() -> Result<(), Error> {
     p.exp_eof()?;
     Ok(())
 }
-
-fn main() {
-    do_ftp().unwrap_or_else(|e| panic!("ftp job failed with {}", e));
-}

examples/repl.rs

@@ -25,7 +25,7 @@ fn ed_session() -> Result<PtyReplSession, Error> {
     Ok(ed)
 }
 
-fn do_ed_repl() -> Result<(), Error> {
+fn main() -> Result<(), Error> {
     let mut ed = ed_session()?;
     ed.send_line("a")?;
     ed.send_line("ed is the best editor evar")?;
@@ -37,7 +37,3 @@ fn do_ed_repl() -> Result<(), Error> {
     ed.exp_eof()?;
     Ok(())
 }
-
-fn main() {
-    do_ed_repl().unwrap_or_else(|e| panic!("ed session failed with {}", e));
-}

src/lib.rs

@@ -15,13 +15,12 @@
 //! # Basic example
 //!
 //! ```no_run
-//!
 //! extern crate rexpect;
 //!
 //! use rexpect::spawn;
-//! use rexpect::error::*;
+//! use rexpect::error::Error;
 //!
-//! fn do_ftp() -> Result<()> {
+//! fn main() -> Result<(), Error> {
 //!     let mut p = spawn("ftp speedtest.tele2.net", Some(2000))?;
 //!     p.exp_regex("Name \\(.*\\):")?;
 //!     p.send_line("anonymous")?;
@@ -36,11 +35,6 @@
 //!     p.exp_eof()?;
 //!     Ok(())
 //! }
-//!
-//!
-//! fn main() {
-//!     do_ftp().unwrap_or_else(|e| panic!("ftp job failed with {}", e));
-//! }
 //! ```
 //!
 //! # Example with bash
@@ -55,10 +49,9 @@
 //! ```no_run
 //! extern crate rexpect;
 //! use rexpect::spawn_bash;
-//! use rexpect::error::*;
+//! use rexpect::error::Error;
 //!
-//!
-//! fn run() -> Result<()> {
+//! fn main() -> Result<(), Error> {
 //!     let mut p = spawn_bash(Some(30_000))?;
 //!     p.execute("ping 8.8.8.8", "bytes of data")?;
 //!     p.send_control('z')?;
@@ -71,11 +64,6 @@
 //!     p.exp_string("packet loss")?;
 //!     Ok(())
 //! }
-//!
-//! fn main() {
-//!     run().unwrap_or_else(|e| panic!("bash process failed with {}", e));
-//! }
-//!
 //! ```
 
 pub mod error;