Struct wasi_common::WasiCtxBuilder

pub struct WasiCtxBuilder { /* fields omitted */ }

A builder allowing customizable construction of WasiCtx instances.

Methods

impl WasiCtxBuilder

pub fn new() -> Self

Builder for a new WasiCtx.

pub fn args<S: AsRef<[u8]>>(
    &mut self,
    args: impl IntoIterator<Item = S>
) -> &mut Self

Add arguments to the command-line arguments list.

Arguments must be valid UTF-8 with no NUL bytes, or else WasiCtxBuilder::build() will fail.

pub fn arg<S: AsRef<[u8]>>(&mut self, arg: S) -> &mut Self

Add an argument to the command-line arguments list.

Arguments must be valid UTF-8 with no NUL bytes, or else WasiCtxBuilder::build() will fail.

pub fn inherit_args(&mut self) -> &mut Self

Inherit the command-line arguments from the host process.

If any arguments from the host process contain invalid UTF-8, WasiCtxBuilder::build() will fail.

pub fn inherit_stdin(&mut self) -> &mut Self

Inherit stdin from the host process.

pub fn inherit_stdout(&mut self) -> &mut Self

Inherit stdout from the host process.

pub fn inherit_stderr(&mut self) -> &mut Self

Inherit stdout from the host process.

pub fn inherit_stdio(&mut self) -> &mut Self

Inherit the stdin, stdout, and stderr streams from the host process.

pub fn inherit_env(&mut self) -> &mut Self

Inherit the environment variables from the host process.

If any environment variables from the host process contain invalid Unicode (UTF-16 for Windows, UTF-8 for other platforms), WasiCtxBuilder::build() will fail.

pub fn env<S: AsRef<[u8]>>(&mut self, k: S, v: S) -> &mut Self

Add an entry to the environment.

Environment variable keys and values must be valid UTF-8 with no NUL bytes, or else WasiCtxBuilder::build() will fail.

pub fn envs<S: AsRef<[u8]>, T: Borrow<(S, S)>>(
    &mut self,
    envs: impl IntoIterator<Item = T>
) -> &mut Self

Add entries to the environment.

Environment variable keys and values must be valid UTF-8 with no NUL bytes, or else WasiCtxBuilder::build() will fail.

pub fn stdin(&mut self, file: File) -> &mut Self

Provide a File to use as stdin

pub fn stdout(&mut self, file: File) -> &mut Self

Provide a File to use as stdout

pub fn stderr(&mut self, file: File) -> &mut Self

Provide a File to use as stderr

pub fn preopened_dir<P: AsRef<Path>>(
    &mut self,
    dir: File,
    guest_path: P
) -> &mut Self

Add a preopened directory.

pub fn preopened_virt<P: AsRef<Path>>(
    &mut self,
    dir: VirtualDirEntry,
    guest_path: P
) -> &mut Self

Add a preopened virtual directory.

pub fn build(&mut self) -> Result<WasiCtx, WasiCtxBuilderError>

Build a WasiCtx, consuming this WasiCtxBuilder.

If any of the arguments or environment variables in this builder cannot be converted into CStrings, either due to NUL bytes or Unicode conversions, this will fail.