rust-expect 0.1.0

Next-generation Expect-style terminal automation library for Rust
Documentation 
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

//! Convenient re-exports for common rust-expect usage.
//!
//! This module provides a single import to access the most commonly used
//! types and traits from rust-expect.
//!
//! # Example
//!
//! ```ignore
//! use rust_expect::prelude::*;
//!
//! #[tokio::main]
//! async fn main() -> Result<()> {
//!     let mut session = Session::spawn("bash", &[]).await?;
//!     session.expect("$").await?;
//!     session.send_line("echo hello").await?;
//!     session.expect("hello").await?;
//!     Ok(())
//! }
//! ```

// Core types
// Backend types
pub use crate::backend::{BackendType, PtyConfig, PtySpawner};
pub use crate::config::{
    BufferConfig, EncodingConfig, HumanTypingConfig, InteractConfig, LineEnding, LogFormat,
    LoggingConfig, SessionConfig, TimeoutConfig,
};
// Encoding utilities
pub use crate::encoding::{
    DetectedEncoding, EncodedText, LineEndingStyle, decode_utf8_lossy, detect_encoding_from_env,
    detect_line_ending, normalize_line_endings, strip_ansi,
};
// Error handling
pub use crate::error::{ExpectError, Result, SpawnError};
// Pattern types
pub use crate::expect::{Matcher, Pattern, PatternManager, PatternSet, RingBuffer};
// Send traits
pub use crate::send::{AnsiSend, BasicSend, HumanTyper, Sender};
// Session types
pub use crate::session::{QuickSession, Session, SessionBuilder};
// Sync wrapper
pub use crate::sync::{SyncSession, block_on};
// Common types
pub use crate::types::{
    ControlChar, Dimensions, ExpectResult, Match, ProcessExitStatus, SessionId, SessionState,
};
// Macros (re-exported from rust-expect-macros)
pub use crate::{dialog, patterns, regex, timeout};