Struct MicroVm

pub struct MicroVm { /* private fields */ }

A lightweight Linux virtual machine.

MicroVm provides a secure, isolated environment for running applications with their own filesystem, network, and resource constraints.

Examples

use microsandbox_core::vm::{MicroVm, Rootfs};
use tempfile::TempDir;

let temp_dir = TempDir::new()?;
let vm = MicroVm::builder()
    .rootfs(Rootfs::Native(temp_dir.path().to_path_buf()))
    .ram_mib(1024)
    .exec_path("/bin/echo")
    .args(["Hello, World!"])
    .build()?;

// Start the MicroVm
vm.start()?;  // This would actually run the VM

Implementations

impl MicroVm

pub fn get_config(&self) -> &MicroVmConfig

The configuration for the MicroVm.

impl MicroVm

pub fn from_config(config: MicroVmConfig) -> MicrosandboxResult<Self>

Creates a new MicroVm from the given configuration.

This is a low-level constructor - prefer using MicroVm::builder() for a more ergonomic interface.

Errors

Returns an error if:

• The configuration is invalid
• Required resources cannot be allocated
• The system lacks required capabilities

pub fn builder() -> MicroVmBuilder<(), ()>

Creates a builder for configuring a new MicroVm instance.

This is the recommended way to create a new MicroVm.

Examples

use microsandbox_core::vm::{MicroVm, Rootfs};
use tempfile::TempDir;

let temp_dir = TempDir::new()?;
let vm = MicroVm::builder()
    .rootfs(Rootfs::Native(temp_dir.path().to_path_buf()))
    .ram_mib(1024)
    .exec_path("/bin/echo")
    .build()?;

pub fn start(&self) -> MicrosandboxResult<i32>

Starts the MicroVm and waits for it to complete.

This function will block until the MicroVm exits. The exit status of the guest process is returned.

Examples

use microsandbox_core::vm::{MicroVm, Rootfs};
use tempfile::TempDir;

let temp_dir = TempDir::new()?;
let vm = MicroVm::builder()
    .rootfs(Rootfs::Native(temp_dir.path().to_path_buf()))
    .ram_mib(1024)
    .exec_path("/usr/bin/python3")
    .args(["-c", "print('Hello from MicroVm!')"])
    .build()?;

// let status = vm.start()?;
// assert_eq!(status, 0);  // Process exited successfully

Notes

• This function takes control of stdin/stdout
• The MicroVm is automatically cleaned up when this returns
• A non-zero status indicates the guest process failed

Trait Implementations

impl Debug for MicroVm

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

Formats the value using the given formatter.

impl Drop for MicroVm

fn drop(&mut self)

Executes the destructor for this type.