Struct SandboxCreateOptions 

pub struct SandboxCreateOptions {

    pub image: String,
    pub timeout_seconds: u64,
    pub envs: BTreeMap<String, String>,
    pub metadata: BTreeMap<String, String>,
    pub name: Option<String>,
    pub cpus: Option<u32>,
    pub memory_mb: Option<u32>,
    pub isolation: ExecutionIsolation,
    pub rootfs_snapshot_id: Option<ExecutionSnapshotId>,
    pub workspace: Option<PathBuf>,
    pub workdir: Option<String>,
    pub user: Option<String>,
    pub hostname: Option<String>,
    pub mounts: Vec<VolumeMount>,
    pub tmpfs: Vec<TmpfsMount>,
    pub network: SandboxNetwork,
    pub ports: Vec<PortMapping>,
    pub dns_servers: Vec<String>,
    pub host_aliases: BTreeMap<String, String>,
    pub read_only: bool,
    pub persistent: bool,
    pub auto_remove: bool,
}

Options for super::Sandbox::create_with_options.

MicroVM isolation is the default. Shared-kernel Sandbox isolation must be selected explicitly with SandboxCreateOptions::isolation.

Fields

image: String

timeout_seconds: u64

envs: BTreeMap<String, String>

metadata: BTreeMap<String, String>

name: Option<String>

cpus: Option<u32>

memory_mb: Option<u32>

isolation: ExecutionIsolation

rootfs_snapshot_id: Option<ExecutionSnapshotId>

workspace: Option<PathBuf>

workdir: Option<String>

user: Option<String>

hostname: Option<String>

mounts: Vec<VolumeMount>

tmpfs: Vec<TmpfsMount>

network: SandboxNetwork

ports: Vec<PortMapping>

dns_servers: Vec<String>

host_aliases: BTreeMap<String, String>

read_only: bool

persistent: bool

auto_remove: bool

Implementations

impl SandboxCreateOptions

pub fn new(image: impl Into<String>) -> Self

pub const fn timeout_seconds(self, timeout_seconds: u64) -> Self

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

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

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

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

pub const fn memory_mb(self, memory_mb: u32) -> Self

pub const fn isolation(self, isolation: ExecutionIsolation) -> Self

pub fn filesystem_snapshot(self, snapshot_id: ExecutionSnapshotId) -> Self

Start from a runtime-managed immutable filesystem snapshot.

Snapshot identifiers are typed and validated by the runtime; callers cannot provide an arbitrary host path.

pub fn workspace(self, path: impl Into<PathBuf>) -> Self

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

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

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

pub fn mount(self, mount: VolumeMount) -> Self

pub fn tmpfs(self, mount: TmpfsMount) -> Self

pub fn network(self, network: SandboxNetwork) -> Self

pub fn publish_port(self, port: PortMapping) -> Self

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

pub fn host_alias(self, host: impl Into<String>, ip: impl Into<String>) -> Self

pub const fn read_only(self, read_only: bool) -> Self

pub const fn persistent(self, persistent: bool) -> Self

pub const fn auto_remove(self, auto_remove: bool) -> Self

Trait Implementations

impl Clone for SandboxCreateOptions

fn clone(&self) -> SandboxCreateOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SandboxCreateOptions

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

Formats the value using the given formatter.

impl Default for SandboxCreateOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for SandboxCreateOptions

impl PartialEq for SandboxCreateOptions

fn eq(&self, other: &SandboxCreateOptions) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SandboxCreateOptions