Struct TerminalHandle 

pub struct TerminalHandle { /* private fields */ }

Handle to an active terminal session

This provides a convenient wrapper around a TerminalId that tracks the terminal client and can be used to interact with the terminal.

When dropped, the handle will attempt to release the terminal if it hasn’t been explicitly released or if the command hasn’t completed.

Implementations

impl TerminalHandle

pub fn new(terminal_id: TerminalId, client: Arc<TerminalClient>) -> Self

Create a new terminal handle

pub fn id(&self) -> &TerminalId

Get the terminal ID

pub fn id_str(&self) -> &str

Get the terminal ID as a string

pub async fn output(&self) -> Result<TerminalOutputResponse, AgentError>

Get the current output and status

pub async fn wait_for_exit(&self) -> Result<TerminalExitStatus, AgentError>

Wait for the terminal command to exit

Returns the exit status once the command completes.

pub async fn kill(&self) -> Result<(), AgentError>

Kill the terminal command

Sends SIGTERM to terminate the command. The terminal remains valid and can still be queried for output.

pub async fn release(self) -> Result<(), AgentError>

Release the terminal and free resources

After calling this, the handle should not be used again.

pub async fn execute_and_wait( &self, ) -> Result<(String, TerminalExitStatus), AgentError>

Execute a command and wait for completion, returning the output

This is a convenience method that polls for output and waits for exit. Returns the final output and exit status.

pub fn is_released(&self) -> bool

Check if the terminal has been released

Trait Implementations

impl Debug for TerminalHandle

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

Formats the value using the given formatter.

impl Drop for TerminalHandle

fn drop(&mut self)

Executes the destructor for this type.