Struct PipetteClient 

pub struct PipetteClient { /* private fields */ }

A client to a running pipette instance inside a VM.

Implementations

impl PipetteClient

pub async fn new( spawner: impl Spawn, conn: impl 'static + AsyncRead + AsyncWrite + Send + Unpin, output_dir: &Path, ) -> Result<Self, RecvError>

Connects to a pipette instance inside a VM.

conn must be an established connection over some byte stream (e.g., a socket).

pub async fn ping(&self) -> Result<(), RpcError>

Pings the agent to check if it’s alive.

pub fn windows_shell(&self) -> WindowsShell<'_>

Return a shell object to interact with a Windows guest.

pub fn unix_shell(&self) -> UnixShell<'_>

Return a shell object to interact with a Linux guest.

pub async fn mount( &self, source: &str, target: &str, fstype: &str, flags: u64, mkdir_target: bool, ) -> Result<()>

Mounts a filesystem inside the guest (Linux only).

pub async fn prepare_chroot(&self, target: &str) -> Result<()>

Prepares a chroot by bind-mounting /proc, /dev, and /sys into it, and mounting a writable tmpfs at /tmp.

pub fn command(&self, program: impl AsRef<str>) -> Command<'_>

Returns an object used to launch a command inside the guest.

TODO: this is a low-level interface. Make a high-level interface like xshell::Shell for manipulating the environment and launching processes.

pub async fn power_off(&self) -> Result<()>

Sends a request to the guest to power off.

pub async fn reboot(&self) -> Result<()>

Sends a request to the guest to reboot.

pub async fn read_file(&self, path: impl AsRef<str>) -> Result<Vec<u8>>

Reads the full contents of a file.

pub async fn write_file( &self, path: impl AsRef<str>, contents: impl AsyncRead, ) -> Result<()>

Writes a file to the guest. Note: This may transfer the file in chunks. It is likely not suitable for writing to files that require all content to be written at once, e.g. files in /proc or /sys.

pub async fn wait(self) -> Result<(), RecvError>

Waits for the agent to exit.

pub async fn get_time(&self) -> Result<Timestamp>

Returns the current time in the guest.

pub async fn crash(&self) -> Result<(), RemoteError>

Tell the agent to crash itself.

pub async fn kernel_crash(&self) -> Result<(), RemoteError>

Tell the agent to crash the kernel.