Struct DialogStep 

pub struct DialogStep {
    pub name: String,
    pub expect: Option<String>,
    pub send: Option<String>,
    pub send_control: Option<ControlChar>,
    pub timeout: Option<Duration>,
    pub continue_on_timeout: bool,
    pub next: Option<String>,
    pub branches: HashMap<String, String>,
}

A dialog step definition.

Fields

name: String

Name of this step (optional for simple dialogs).

expect: Option<String>

Pattern to expect.

send: Option<String>

Response to send.

send_control: Option<ControlChar>

Control character to send (alternative to text).

timeout: Option<Duration>

Timeout for this step.

continue_on_timeout: bool

Whether to continue on timeout.

next: Option<String>

Next step name (for branching).

branches: HashMap<String, String>

Conditional branches.

Implementations

impl DialogStep

pub fn new(name: impl Into<String>) -> Self

Create a new step with a name.

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

Create a step that expects a pattern (simple unnamed step).

pub fn send(text: impl Into<String>) -> Self

Create a step that sends text (simple unnamed step).

pub fn with_expect(self, pattern: impl Into<String>) -> Self

Chain: set the pattern to expect (builder pattern).

pub fn with_send(self, text: impl Into<String>) -> Self

Chain: set the text to send (builder pattern).

pub const fn with_send_control(self, ctrl: ControlChar) -> Self

Chain: set a control character to send (e.g., Ctrl+C).

pub fn then_send(self, text: impl Into<String>) -> Self

Chain: set the text to send after expecting. Alias for with_send, for fluent API.

pub const fn then_send_control(self, ctrl: ControlChar) -> Self

Chain: set a control character to send after expecting. Alias for with_send_control, for fluent API.

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

Set the timeout for this step.

pub fn then(self, next: impl Into<String>) -> Self

Set the next step name.

pub fn branch(self, pattern: impl Into<String>, step: impl Into<String>) -> Self

Add a conditional branch.

pub const fn continue_on_timeout(self, cont: bool) -> Self

Set whether to continue on timeout.

pub fn expect_pattern(&self) -> Option<&str>

Get the expect pattern.

pub fn send_text(&self) -> Option<&str>

Get the send text.

pub const fn send_control(&self) -> Option<ControlChar>

Get the control character to send.

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

Get the timeout.

pub const fn continues_on_timeout(&self) -> bool

Check if should continue on timeout.

Trait Implementations

impl Clone for DialogStep

fn clone(&self) -> DialogStep

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DialogStep

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

Formats the value using the given formatter.

impl Default for DialogStep

fn default() -> DialogStep

Returns the “default value” for a type.