Enum Pattern 

pub enum Pattern {
    Literal(String),
    Regex(CompiledRegex),
    Glob(String),
    Eof,
    Timeout(Duration),
    Bytes(usize),
}

A pattern that can be matched against terminal output.

Variants

Literal(String)

Match an exact string.

Regex(CompiledRegex)

Match a regular expression.

Glob(String)

Match a glob pattern.

Eof

Match end of file (process terminated).

Timeout(Duration)

Match after a timeout.

Bytes(usize)

Match when N bytes have been received.

Implementations

impl Pattern

pub fn literal(s: impl Into<String>) -> Self

Create a literal pattern.

pub fn regex(pattern: &str) -> Result<Self, Error>

Create a regex pattern.

Errors

Returns an error if the regex pattern is invalid.

pub fn glob(pattern: impl Into<String>) -> Self

Create a glob pattern.

pub const fn eof() -> Self

Create an EOF pattern.

pub const fn timeout(duration: Duration) -> Self

Create a timeout pattern.

pub const fn bytes(n: usize) -> Self

Create a bytes pattern.

pub fn as_str(&self) -> &str

Get the pattern as a string for display purposes.

pub fn matches(&self, text: &str) -> Option<PatternMatch>

Check if this pattern matches the given text.

Returns the match position and captures if successful.

pub const fn is_timeout(&self) -> bool

Check if this is a timeout pattern.

pub const fn is_eof(&self) -> bool

Check if this is an EOF pattern.

pub const fn timeout_duration(&self) -> Option<Duration>

Get the timeout duration if this is a timeout pattern.

pub fn shell_prompt() -> Self

Create a pattern that matches common shell prompts.

Matches prompts ending with $, #, >, or % followed by optional whitespace. This handles most Unix shells (bash, zsh, sh) and root prompts.

Examples

use rust_expect::Pattern;

let prompt = Pattern::shell_prompt();
assert!(prompt.matches("user@host:~$ ").is_some());
assert!(prompt.matches("root@host:~# ").is_some());
assert!(prompt.matches("> ").is_some());

pub fn any_prompt() -> Self

Create a pattern that matches any common prompt character.

A simpler alternative to shell_prompt() that uses glob matching. Less precise but faster for simple cases.

pub fn ipv4() -> Result<Self, Error>

Create a pattern that matches IPv4 addresses.

Errors

Returns an error if the regex compilation fails (should not happen).

Examples

use rust_expect::Pattern;

let ipv4 = Pattern::ipv4().unwrap();
assert!(ipv4.matches("Server IP: 192.168.1.1").is_some());
assert!(ipv4.matches("10.0.0.255 is local").is_some());

pub fn email() -> Result<Self, Error>

Create a pattern that matches email addresses.

Errors

Returns an error if the regex compilation fails (should not happen).

Examples

use rust_expect::Pattern;

let email = Pattern::email().unwrap();
assert!(email.matches("Contact: user@example.com").is_some());

pub fn timestamp_iso8601() -> Result<Self, Error>

Create a pattern that matches ISO 8601 timestamps.

Matches formats like 2024-01-15T10:30:00 or 2024-01-15 10:30:00.

Errors

Returns an error if the regex compilation fails (should not happen).

pub fn error_indicator() -> Self

Create a pattern that matches common error indicators.

Matches words like “error”, “failed”, “fatal” (case-insensitive).

Examples

use rust_expect::Pattern;

let error = Pattern::error_indicator();
assert!(error.matches("Error: connection refused").is_some());
assert!(error.matches("Command FAILED").is_some());

pub fn success_indicator() -> Self

Create a pattern that matches common success indicators.

Matches words like “success”, “passed”, “complete”, “ok” (case-insensitive).

pub fn password_prompt() -> Self

Create a pattern that matches common password prompts.

Matches prompts like “Password:”, “password: “, “Passphrase:”.

Examples

use rust_expect::Pattern;

let pwd = Pattern::password_prompt();
assert!(pwd.matches("Password: ").is_some());
assert!(pwd.matches("Enter passphrase: ").is_some());

pub fn login_prompt() -> Self

Create a pattern that matches common login/username prompts.

Matches prompts like “login:”, “Username:”, “user: “.

pub fn confirmation_prompt() -> Self

Create a pattern that matches common yes/no confirmation prompts.

Matches prompts like “[y/n]”, “(yes/no)”, “[Y/n]”.

pub fn continue_prompt() -> Self

Create a pattern that matches common “continue?” prompts.

Matches prompts like “Continue?”, “Do you want to continue?”, “Press any key”.

Trait Implementations

impl Clone for Pattern

fn clone(&self) -> Pattern

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Pattern

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&str> for Pattern

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Pattern

fn from(s: String) -> Self

Converts to this type from the input type.