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
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

//! rust-expect: Next-generation terminal automation library
//!
//! This crate provides an Expect-style API for automating interactive terminal applications.
//! It supports local PTY sessions, SSH connections, and mock sessions for testing.
//!
//! # Features
//!
//! - **Async-first design** with Tokio runtime
//! - **Cross-platform PTY support** via `rust-pty`
//! - **Flexible pattern matching** with regex, literal, and custom matchers
//! - **SSH backend** for remote automation (feature: `ssh`)
//! - **Mock backend** for testing (feature: `mock`)
//! - **Screen buffer** with ANSI parsing (feature: `screen`)
//! - **PII redaction** for sensitive data handling (feature: `pii-redaction`)
//!
//! # Example
//!
//! ```ignore
//! use rust_expect::prelude::*;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), ExpectError> {
//!     let mut session = Session::spawn("/bin/bash", &[]).await?;
//!     session.expect("$").await?;
//!     session.send_line("echo hello").await?;
//!     session.expect("hello").await?;
//!     Ok(())
//! }
//! ```

// Re-export macros
pub use rust_expect_macros::{dialog, patterns, regex, timeout};

// Core types (Phase 4)
pub mod config;
pub mod encoding;
pub mod error;
pub mod prelude;
pub mod types;
pub mod validation;

// Core modules (Phase 5)
pub mod backend;
pub mod expect;
pub mod send;
pub mod session;
pub mod sync;
pub mod util;

// Feature modules (Phase 6)
pub mod auto_config;
pub mod dialog;
pub mod health;
pub mod interact;
pub mod metrics;
pub mod multi;
pub mod transcript;

/// Mock backend for testing.
#[cfg(feature = "mock")]
pub mod mock;

/// Screen buffer with ANSI parsing.
#[cfg(feature = "screen")]
pub mod screen;

/// PII detection and redaction.
#[cfg(feature = "pii-redaction")]
pub mod pii;

// Re-export commonly used items from Phase 4
// Re-export commonly used items from Phase 6
pub use auto_config::{LocaleInfo, ShellType, detect_shell};
// Re-export commonly used items from Phase 5
pub use backend::{BackendType, PtyConfig, PtySpawner};
pub use config::{
    BufferConfig, EncodingConfig, HumanTypingConfig, InteractConfig, LineEnding, LogFormat,
    LoggingConfig, SessionConfig, TimeoutConfig,
};
pub use dialog::{Dialog, DialogBuilder, DialogStep};
pub use encoding::{
    DetectedEncoding, EncodedText, LineEndingStyle, decode_utf8_lossy, detect_encoding_from_env,
    detect_line_ending, normalize_line_endings, strip_ansi,
};
pub use error::{ExpectError, Result, SpawnError};
pub use expect::{
    CacheStats, CompiledRegex, GLOBAL_CACHE, Matcher, Pattern, PatternManager, PatternSet,
    RegexCache, RingBuffer, get_regex,
};
pub use health::{HealthChecker, HealthStatus};
pub use interact::{
    InteractAction, InteractBuilder, InteractContext, InteractEndReason, InteractResult,
    InteractionMode, ResizeContext, ResizeHook, TerminalMode, TerminalState,
};
pub use metrics::{Counter, Gauge, Histogram, MetricsRegistry, SessionMetrics};
// Conditional re-exports
#[cfg(feature = "mock")]
pub use mock::{MockBuilder, MockSession, MockTransport, Scenario};
pub use multi::{
    GroupBuilder, GroupManager, GroupResult, MultiSessionManager, PatternSelector, ReadyType,
    SelectResult, SendResult, SessionGroup,
};
#[cfg(feature = "pii-redaction")]
pub use pii::{PiiDetector, PiiRedactor, PiiType};
#[cfg(feature = "screen")]
pub use screen::{Attributes, Cell, ScreenBuffer};
pub use send::{AnsiSend, BasicSend, HumanTyper, Sender};
pub use session::{QuickSession, Session, SessionBuilder};
pub use sync::{SyncSession, block_on};
pub use transcript::{Player, Recorder, Transcript, TranscriptEvent};
pub use types::{
    ControlChar, Dimensions, ExpectResult, Match, ProcessExitStatus, SessionId, SessionState,
};
pub use util::{Backpressure, Deadline, TimeoutExt};

// Test utilities (Phase 7)
#[cfg(any(test, feature = "test-utils"))]
pub mod test_utils;

#[cfg(any(test, feature = "test-utils"))]
pub use test_utils::{
    ExpectTestBuilder, FakePty, FakePtyPair, Fixtures, OutputAssertions, RecordedInteraction,
    SessionTestBuilder, TestFixture, TestSession, TestSessionBuilder, assert_output_contains,
    assert_output_matches,
};