Struct ExecClient 

pub struct ExecClient { /* private fields */ }

Client for executing commands in the guest over Unix socket.

Uses the Frame wire protocol: sends a Data frame with JSON ExecRequest, receives a Data frame with JSON ExecOutput.

Implementations

impl ExecClient

pub async fn connect(socket_path: &Path) -> Result<Self>

Connect to the exec server via Unix socket.

Verifies the socket is connectable.

pub fn socket_path(&self) -> &Path

Get the socket path this client is connected to.

pub async fn exec_command(&self, request: &ExecRequest) -> Result<ExecOutput>

Execute a command in the guest.

Sends a Data frame with JSON ExecRequest, reads a Data frame with JSON ExecOutput.

pub async fn exec_stream(&self, request: &ExecRequest) -> Result<StreamingExec>

Execute a command in streaming mode.

Sends a Data frame with JSON ExecRequest (streaming=true), then reads multiple frames: ExecChunk frames for stdout/stderr data, and a final ExecExit frame with the exit code.

Returns a StreamingExec handle for reading events.

pub async fn file_transfer(&self, request: &FileRequest) -> Result<FileResponse>

Transfer a file to/from the guest.

Sends a Data frame with JSON FileRequest, reads a Data frame with JSON FileResponse.

pub async fn heartbeat(&self) -> Result<bool>

Send a Heartbeat frame and wait for a Heartbeat response.

Returns true if the exec server responds, false otherwise.

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

Ask the guest to deliver signal (a signal number, e.g. 15 for SIGTERM) to the main container process for graceful shutdown. The guest runs the container’s own stop handler; when it exits, guest init exits and the VM stops cleanly. Returns Ok(true) if the guest acknowledged, Ok(false) if it did not respond (caller should fall back to a hard stop).

pub async fn spawn_main(&self, spec_json: Option<&[u8]>) -> Result<bool>

Ask a guest that booted IDLE (BOX_DEFERRED_MAIN=1) to spawn its container command — already known to the guest via BOX_EXEC_* — as the MAIN process. The spawned main inherits the console (so its output reaches the json-file logs) and drives the VM lifecycle. Returns Ok(true) if acknowledged.

Trait Implementations

impl Debug for ExecClient

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

Formats the value using the given formatter.