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 sailbox_id(&self) -> &str

The sailbox this exec runs on.

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 async fn forward_port( &self, local_port: u16, remote_port: u16, ) -> Result<PortForward, SailError>

Forward a local port to a guest-local port over this session. The listener binds on 127.0.0.1; passing local_port 0 lets the OS pick a free port (read back from the returned handle). Dropping the handle stops the forward.

pub async fn next_forward_event(&self) -> Option<ForwardEvent>

Await the next local-forwarding event (e.g. a browser open) for an interactive session. Returns None once the stream has ended and no queued events remain. The shell driver consumes these to act on the user’s machine.

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 resync(&self)

Ask a pty exec to re-emit its current screen as a Snapshot on the live stream. A client whose local buffer dropped output (it fell behind a fast producer) calls this to repaint instead of rendering a torn tail; the command keeps running detached. Advisory and best-effort like resize: an unknown, finished, or non-pty exec is a server no-op, and a transient error is swallowed (the client re-requests if it is still behind).

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.