1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
//! The main crate of Rexpect
//!
//! # Overview
//!
//! Rexpect is a loose port of [pexpect](https://pexpect.readthedocs.io/en/stable/)
//! which itself is inspired by Don Libe's expect.
//!
//! It's main components (depending on your need you can use either of those)
//!
//! - [session](session/index.html): automate stuff in Rust
//! - [reader](reader/index.html): a non-blocking reader with buffering, matching on
//! strings/regex/...
//! - [process](process/index.html): spawn a process in a pty
//!
//! # Basic example
//!
//! ```no_run
//! extern crate rexpect;
//!
//! use rexpect::spawn;
//! use rexpect::error::Error;
//!
//! fn main() -> Result<(), Error> {
//! let mut p = spawn("ftp speedtest.tele2.net", Some(2000))?;
//! p.exp_regex("Name \\(.*\\):")?;
//! p.send_line("anonymous")?;
//! p.exp_string("Password")?;
//! p.send_line("test")?;
//! p.exp_string("ftp>")?;
//! p.send_line("cd upload")?;
//! p.exp_string("successfully changed.\r\nftp>")?;
//! p.send_line("pwd")?;
//! p.exp_regex("[0-9]+ \"/upload\"")?;
//! p.send_line("exit")?;
//! p.exp_eof()?;
//! Ok(())
//! }
//! ```
//!
//! # Example with bash
//!
//! Tip: try the chain of commands first in a bash session.
//! The tricky thing is to get the wait_for_prompt right.
//! What `wait_for_prompt` actually does is seeking to the next
//! visible prompt. If you forgot to call this once your next call to
//! `wait_for_prompt` comes out of sync and you're seeking to a prompt
//! printed "above" the last `execute()`.
//!
//! ```no_run
//! extern crate rexpect;
//! use rexpect::spawn_bash;
//! use rexpect::error::Error;
//!
//! 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')?;
//! p.wait_for_prompt()?;
//! p.execute("bg", "suspended")?;
//! p.send_line("sleep 1")?;
//! p.wait_for_prompt()?;
//! p.execute("fg", "continued")?;
//! p.send_control('c')?;
//! p.exp_string("packet loss")?;
//! Ok(())
//! }
//! ```
pub mod error;
pub mod process;
pub mod reader;
pub mod session;
pub use reader::ReadUntil;
pub use session::{spawn, spawn_bash, spawn_python, spawn_stream};