Struct LinuxBuilder 

pub struct LinuxBuilder { /* private fields */ }

Boots an OCI image as a Linux microVM (bsdkrun linux).

Implementations

impl LinuxBuilder

pub fn name(self, name: impl Into<String>) -> Self

Name the machine (--name).

pub fn cpus(self, cpus: u32) -> Self

vCPU count (--cpus).

pub fn mem(self, mib: u32) -> Self

Guest RAM in MiB (--mem).

pub fn port(self, forward: impl Into<String>) -> Self

Add a host->guest TCP port forward, "HOST:GUEST".

pub fn forward(self, host: u16, guest: u16) -> Self

Add a port forward from numbers instead of a string.

pub fn mac(self, mac: impl Into<String>) -> Self

Pin the guest MAC address (--mac).

pub fn network(self, network: impl Into<String>) -> Self

Join a global network (--network).

pub fn no_net(self) -> Self

Disable guest networking entirely (--no-net).

pub fn log_level(self, level: u32) -> Self

bsdkrun’s global --log-level for the create call (default 1, so boot diagnostics land in the error when a boot fails).

pub fn to_args(&self) -> Vec<String>

The exact argv create() will run (minus the binary and global flags) — for inspection and tests.

pub fn create(self) -> Result<Sandbox>

Boot the machine (detached) and return a handle to it.

pub fn kernel(self, kernel: impl Into<String>) -> Self

Custom kernel image (--kernel).

pub fn kernel_version(self, version: impl Into<String>) -> Self

Kernel version to fetch (--kernel-version).

pub fn initramfs(self) -> Self

Boot through an initramfs (--initramfs, a bare flag for Linux).

pub fn volume(self, name: impl Into<String>) -> Self

Use a persistent CoW volume as the rootfs (-v).

pub fn mount(self, mount: impl Into<String>) -> Self

Share a host directory into the guest, "HOST:GUEST" or "HOST:GUEST:ro" (--mount, repeatable).

pub fn attach_disk(self, disk: impl Into<String>) -> Self

Attach an extra raw disk as virtio-blk, "PATH" or "PATH:ro" (--attach-disk, repeatable). With the default virtio-fs rootfs the first attachment is the guest’s /dev/vda — format and mount it in the guest for native-speed I/O.

pub fn entrypoint(self, entrypoint: impl Into<String>) -> Self

Override the image entrypoint (--entrypoint).

pub fn env(self, key: impl Into<String>, value: impl Into<String>) -> Self

Set an environment variable for the guest’s entrypoint (-e K=V, repeatable). Merged over the image’s own config, so a key the image already defines is replaced rather than duplicated.

pub fn envs<K, V>(self, vars: impl IntoIterator<Item = (K, V)>) -> Self

where K: Into<String>, V: Into<String>,

Set several environment variables at once.

pub fn console(self, console: impl Into<String>) -> Self

Console device (--console).

pub fn command<I, S>(self, command: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

The command to run in the guest (argv after --).

Trait Implementations

impl Clone for LinuxBuilder

fn clone(&self) -> LinuxBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LinuxBuilder

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

Formats the value using the given formatter.