Skip to main content

Module prelude

Module prelude 

Source
Expand description

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

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(())
}

Re-exports§

pub use crate::backend::BackendType;
pub use crate::backend::PtyConfig;
pub use crate::backend::PtySpawner;
pub use crate::config::BufferConfig;
pub use crate::config::EncodingConfig;
pub use crate::config::HumanTypingConfig;
pub use crate::config::InteractConfig;
pub use crate::config::LineEnding;
pub use crate::config::LogFormat;
pub use crate::config::LoggingConfig;
pub use crate::config::SessionConfig;
pub use crate::config::TimeoutConfig;
pub use crate::encoding::DetectedEncoding;
pub use crate::encoding::EncodedText;
pub use crate::encoding::LineEndingStyle;
pub use crate::encoding::decode_utf8_lossy;
pub use crate::encoding::detect_encoding_from_env;
pub use crate::encoding::detect_line_ending;
pub use crate::encoding::normalize_line_endings;
pub use crate::encoding::strip_ansi;
pub use crate::error::ExpectError;
pub use crate::error::Result;
pub use crate::error::SpawnError;
pub use crate::expect::Matcher;
pub use crate::expect::Pattern;
pub use crate::expect::PatternManager;
pub use crate::expect::PatternSet;
pub use crate::expect::RingBuffer;
pub use crate::send::AnsiSend;
pub use crate::send::BasicSend;
pub use crate::send::HumanTyper;
pub use crate::send::Sender;
pub use crate::session::QuickSession;
pub use crate::session::Session;
pub use crate::session::SessionBuilder;
pub use crate::sync::SyncSession;
pub use crate::sync::block_on;
pub use crate::types::ControlChar;
pub use crate::types::Dimensions;
pub use crate::types::ExpectResult;
pub use crate::types::Match;
pub use crate::types::ProcessExitStatus;
pub use crate::types::SessionId;
pub use crate::types::SessionState;
pub use crate::dialog;

Macros§

dialog
Define an interactive dialog script.
patterns
Define a set of patterns for use with expect operations.
regex
Compile-time validated regex pattern.
timeout
Parse a human-readable timeout specification.