Struct ShellSession 

pub struct ShellSession { /* private fields */ }

A live interactive session opened by Client::shell.

Output and exit events arrive on the shared WS transport’s reader thread and are handed to whatever callbacks are registered via ShellSession::on_output / ShellSession::on_exit at the time they arrive. Callbacks run holding the session’s internal lock, so they must not call on_output/on_exit themselves (writing and resizing is fine).

Implementations

impl ShellSession

pub fn id(&self) -> &str

The session id, as openShell returned it.

pub fn on_output(&self, cb: impl FnMut(&[u8]) + Send + 'static)

Register the output callback; anything buffered so far is flushed to it immediately.

pub fn on_exit(&self, cb: impl FnMut(i32) + Send + 'static)

Register the exit callback; a buffered exit fires immediately.

pub fn write(&self, data: impl AsRef<[u8]>) -> Result<()>

Send keystrokes (arbitrary bytes) to the session.

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

Apply a terminal resize, so full-screen programs in the guest redraw.

pub fn close(&mut self)

Close the session and kill its command. Idempotent.

Trait Implementations

impl Debug for ShellSession

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

Formats the value using the given formatter.