Struct SandboxSpec 

pub struct SandboxSpec {
    host_workdir: PathBuf,
    command: Vec<String>,
    sandbox_workdir: PathBuf,
    scratches: Vec<PathBuf>,
    additional_files: Vec<AdditionalFile>,
    env_vars: Vec<EnvVar>,
    with_inputs: InputsProvider,
    provide_shell: Option<PathBuf>,
    allow_network: bool,
}

A sandbox builder.

Its API is tailored to the needs of Snix builds, namely running sandboxed commands with optional build input paths, files, network access. And allow for such commands to produce outputs that stay available after the sandbox has stopped.

Fields

host_workdir: PathBuf

Working directory on the host, where the sandbox is assembled.

command: Vec<String>

Command to execute inside the sandbox

sandbox_workdir: PathBuf

Workdir inside the sandbox, in which the Self::command will be executed.

scratches: Vec<PathBuf>

A list of scratch paths to make available inside the sandbox.

These directories are read+writable inside the sandbox and their contents is preserved after the sandbox has stopped.

additional_files: Vec<AdditionalFile>

Any additional files to rw-mount inside the sandbox.

env_vars: Vec<EnvVar>

Env vars to set before running Self::command.

with_inputs: InputsProvider

Optionally read-only mount build inputs.

Example

Mount some host path at “/nix/store” inside the sandbox.

use snix_build::sandbox::SandboxSpec;
let _  = SandboxSpec::builder()
    .host_workdir("/tmp/sandbox1")
    .command(["echo", "Hello"])
    .sandbox_workdir("build")
    .scratches(["foo"])
    .with_inputs("nix/store", |path| {
        // mount dir at `path`
        // return an RAII guard that will unmount the dir
        Ok(())
    })
    .build();

provide_shell: Option<PathBuf>

Absolute path to the shell that will be mounted at /bin/sh inside the sandbox.

It must static binary, otherwise it will likely fail to start.

allow_network: bool

Whether to allow network access inside the sandbox.

Implementations

impl SandboxSpec

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

Create a builder for building SandboxSpec. On the builder, call .host_workdir(...), .command(...), .sandbox_workdir(...), .scratches(...), .additional_files(...)(optional), .env_vars(...)(optional), .with_inputs(...)(optional), .provide_shell(...)(optional), .allow_network(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of SandboxSpec.

impl SandboxSpec

pub fn host_workdir(&self) -> &Path

pub fn command(&self) -> impl IntoIterator<Item = &String>

pub fn sandbox_workdir(&self) -> &Path

pub fn scratches(&self) -> impl IntoIterator<Item = &PathBuf>

pub fn additional_files(&self) -> impl IntoIterator<Item = &AdditionalFile>

pub fn env_vars(&self) -> impl IntoIterator<Item = &EnvVar>

pub fn provide_shell(&self) -> Option<&Path>

pub fn allow_network(&self) -> bool

pub fn inputs_provider(&self) -> &InputsProvider

Trait Implementations

impl From<SandboxSpec> for InputsProvider

fn from(value: SandboxSpec) -> Self

Converts to this type from the input type.