Struct DialogExecutor

Source

pub struct DialogExecutor {
    pub max_steps: usize,
    pub default_timeout: Duration,
}

Expand description

Dialog execution state.

Fields§

§max_steps: usize

Maximum number of steps to execute.

§default_timeout: Duration

Default timeout for steps without explicit timeout.

Implementations§

Source §

impl DialogExecutor

Source

pub fn new() -> Self

Create a new executor.

Source

pub const fn max_steps(self, max: usize) -> Self

Set the maximum number of steps.

Source

pub const fn default_timeout(self, timeout: Duration) -> Self

Set the default timeout.

Source

pub fn execute_step_sync( &self, step: &DialogStep, dialog: &Dialog, _buffer: &str, ) -> StepResult

Execute a single step (synchronously - for testing).

This method prepares a step for execution by:

Substituting variables in the send text
Determining the next step to execute

Note: This is a synchronous helper primarily for testing. For actual dialog execution, use the async session-based execution methods.

Source

pub fn step_pattern( &self, step: &DialogStep, dialog: &Dialog, ) -> Option<Pattern>

Get the pattern for a step.

Source

pub async fn execute<T>( &self, session: &mut Session<T>, dialog: &Dialog, ) -> Result<DialogResult>
where T: AsyncReadExt + AsyncWriteExt + Unpin + Send,

Execute a dialog on a session.

This runs through the dialog steps, expecting patterns and sending responses.

§Example

use rust_expect::{Session, Dialog, DialogStep, DialogExecutor};

#[tokio::main]
async fn main() -> Result<(), rust_expect::ExpectError> {
    let mut session = Session::spawn("/bin/bash", &[]).await?;

    let dialog = Dialog::named("login")
        .step(DialogStep::new("prompt")
            .with_expect("$")
            .with_send("echo hello\n"));

    let executor = DialogExecutor::new();
    let result = executor.execute(&mut session, &dialog).await?;
    assert!(result.success);
    Ok(())
}