Struct ExecProcess 

pub struct ExecProcess { /* private fields */ }

A handle to a running command. Drop or ExecProcess::close releases the stream without killing the command.

Implementations

impl ExecProcess

pub fn exec_request_id(&self) -> &str

The durable server-assigned id for this exec, taken from the Started frame. Identifies the command for wait, cancel, resize, and stdin RPCs.

pub fn idempotency_key(&self) -> &str

The idempotency key this exec launched with: the caller’s, or the one minted in start when none was supplied.

pub fn reader(&self, which: OutputStream) -> StreamReader

Create a reader over a live output stream. A fresh reader replays the retained tail from the start, then follows live.

pub fn reader_async(&self, which: OutputStream) -> AsyncStreamReader

Create an async reader over a live output stream (the awaiting twin of reader).

pub fn poll(&self) -> Option<Result<i32, SailError>>

Returns the exit code if the Exit frame arrived on the stream, mapping a not-a-real-result terminal status to its error. None means the result is not known on the stream yet. wait is authoritative.

pub fn close(&self)

Stop the pump and release the stream without touching the remote command.

pub async fn wait(&self) -> Result<ExecResult, SailError>

Wait for the command to finish and return its buffered result.

A clean Exit resolves from the local rings; a stream that ended without one (or whose tail is truncated or short) falls back to WaitSailboxExec, which reattaches to the guest session for the authoritative result, retrying a not-ready box for the exec’s configured retry_timeout budget.

pub async fn cancel( &self, signal: CancelSignal, retry: RetryBudget, ) -> Result<(), SailError>

Signal the command: CancelSignal::Interrupt (SIGINT) or CancelSignal::Kill (SIGKILL).

pub async fn resize(&self, cols: u32, rows: u32)

Set the pty window for a pty exec. Advisory and best-effort: an unknown, finished, or not-yet-placed exec is a server no-op, and a transient transport error is swallowed (the next resize resends).

pub async fn write_stdin(&self, data: &[u8]) -> Result<(), SailError>

Write to the command’s stdin. Chunked with absolute offsets; an uncertain mid-flight failure poisons the writer (a stale-offset resume could silently drop bytes). Blocks (with backoff) while the guest buffer is full.

pub async fn close_stdin(&self) -> Result<(), SailError>

Close the command’s stdin (send EOF).

Trait Implementations

impl Drop for ExecProcess

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.