Struct SandboxEnvironment

Source

pub struct SandboxEnvironment { /* private fields */ }

Expand description

A handle to a Windows Sandbox environment.

This type can represent either a sandbox that was started through SandboxEnvironmentBuilder::start or an existing sandbox referenced by its SandboxId.

The operations on this type wrap the Windows Sandbox CLI. For command behavior and arguments, see Windows Sandbox command line interface.

Implementations§

Source §

impl SandboxEnvironment

Source

pub fn builder() -> SandboxEnvironmentBuilder

Creates a builder for starting a new sandbox environment.

Source

pub fn list() -> Result<Vec<SandboxEnvironment>, SandboxError>

Lists the currently running sandbox environments for the current user.

§Errors

Returns an error if the wsb list command fails or if its JSON response can’t be deserialized.

Source

pub fn from_id(id: SandboxId) -> Self

Creates a handle for an existing sandbox environment by ID.

This does not start a new sandbox.

§Examples

use wsbx::{SandboxEnvironment, SandboxId};

let id: SandboxId = "12345678-1234-1234-1234-1234567890ab".parse()?;
let environment = SandboxEnvironment::from_id(id);
assert_eq!(environment.id(), id);

Source

pub fn id(&self) -> SandboxId

Returns the sandbox ID associated with this environment.

Source

pub fn exec<C, R>( &self, command: C, run_as: R, ) -> Result<ExecResult, SandboxError>
where C: Into<OsString>, R: Into<RunAs>,

Executes a command in the sandbox.

The command is executed using the specified RunAs context.

§Errors

Returns an error if the wsb exec command fails or if its JSON response can’t be deserialized.

§Examples

use wsbx::{RunAs, SandboxEnvironment, SandboxId};

let id: SandboxId = "12345678-1234-1234-1234-1234567890ab".parse()?;
let environment = SandboxEnvironment::from_id(id);
let result = environment.exec("cmd.exe", RunAs::System)?;
let _exit_code = result.exit_code();

Source

pub fn exec_in<C, R, P>( &self, command: C, run_as: R, working_directory: P, ) -> Result<ExecResult, SandboxError>
where C: Into<OsString>, R: Into<RunAs>, P: Into<PathBuf>,

Executes a command in the sandbox with an explicit working directory.

The command is executed using the specified RunAs context and starts in working_directory.

§Errors

Returns an error if the wsb exec command fails or if its JSON response can’t be deserialized.

§Examples

use wsbx::{RunAs, SandboxEnvironment, SandboxId};

let id: SandboxId = "12345678-1234-1234-1234-1234567890ab".parse()?;
let environment = SandboxEnvironment::from_id(id);
let result = environment.exec_in("cmd.exe", RunAs::System, r"C:\Windows")?;
let _exit_code = result.exit_code();