Struct SyncSession 

pub struct SyncSession { /* private fields */ }

A synchronous session wrapper.

This wraps an async session and provides blocking methods for use in synchronous contexts.

Implementations

impl SyncSession

pub fn spawn(command: &str, args: &[&str]) -> Result<Self>

Spawn a command and create a session.

Errors

Returns an error if spawning fails.

pub fn spawn_with_config( command: &str, args: &[&str], config: SessionConfig, ) -> Result<Self>

Spawn with custom configuration.

Errors

Returns an error if spawning fails.

pub const fn config(&self) -> &SessionConfig

Get the session configuration.

pub const fn is_active(&self) -> bool

Check if the session is active.

pub fn pid(&self) -> u32

Get the child process ID.

pub fn send(&mut self, data: &[u8]) -> Result<()>

Send bytes to the session.

Errors

Returns an error if the write fails.

pub fn send_str(&mut self, s: &str) -> Result<()>

Send a string to the session.

Errors

Returns an error if the write fails.

pub fn send_line(&mut self, line: &str) -> Result<()>

Send a line to the session.

Errors

Returns an error if the write fails.

pub fn send_control(&mut self, ctrl: ControlChar) -> Result<()>

Send a control character.

Errors

Returns an error if the write fails.

pub fn expect(&mut self, pattern: impl Into<Pattern>) -> Result<Match>

Expect a pattern in the output.

Errors

Returns an error on timeout or EOF.

pub fn expect_timeout( &mut self, pattern: impl Into<Pattern>, timeout: Duration, ) -> Result<Match>

Expect a pattern with a specific timeout.

Errors

Returns an error on timeout or EOF.

pub fn buffer(&mut self) -> String

Get the current buffer contents.

pub fn clear_buffer(&mut self)

Clear the buffer.

pub fn resize(&mut self, cols: u16, rows: u16) -> Result<()>

Resize the terminal.

Errors

Returns an error if the resize fails.

pub fn signal(&self, signal: i32) -> Result<()>

Send a signal to the child process.

Errors

Returns an error if sending the signal fails.

pub fn kill(&self) -> Result<()>

Kill the child process.

Errors

Returns an error if killing fails.

pub fn block_on<F, T>(&self, future: F) -> T

where F: Future<Output = T>,

Run an async operation synchronously.

Trait Implementations

impl Debug for SyncSession

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

Formats the value using the given formatter.