Struct WasiP1Ctx 

pub struct WasiP1Ctx { /* private fields */ }

Available on crate feature p1 only.

Structure containing state for WASIp1.

This structure is created through WasiCtxBuilder::build_p1 and is configured through the various methods of WasiCtxBuilder. This structure itself implements generated traits for WASIp1 as well as WasiView to have access to WASIp2.

Instances of WasiP1Ctx are typically stored within the T of Store<T>.

Examples

use wasmtime::{Result, Linker};
use wasmtime_wasi::p1::{self, WasiP1Ctx};
use wasmtime_wasi::WasiCtxBuilder;

struct MyState {
    // ... custom state as necessary ...

    wasi: WasiP1Ctx,
}

impl MyState {
    fn new() -> MyState {
        MyState {
            // .. initialize custom state if needed ..

            wasi: WasiCtxBuilder::new()
                .arg("./foo.wasm")
                // .. more customization if necessary ..
                .build_p1(),
        }
    }
}

fn add_to_linker(linker: &mut Linker<MyState>) -> Result<()> {
    p1::add_to_linker_sync(linker, |my_state| &mut my_state.wasi)?;
    Ok(())
}

Trait Implementations

impl WasiSnapshotPreview1 for WasiP1Ctx

fn fd_allocate( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, _offset: Filesize, _len: Filesize, ) -> Result<(), Error>

Force the allocation of space in a file. NOTE: This is similar to posix_fallocate in POSIX.

async fn fd_close( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, ) -> Result<(), Error>

Close a file descriptor. NOTE: This is similar to close in POSIX.

async fn fd_datasync( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, ) -> Result<(), Error>

Synchronize the data of a file to disk. NOTE: This is similar to fdatasync in POSIX.

async fn fd_fdstat_get( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, ) -> Result<Fdstat, Error>

Get the attributes of a file descriptor. NOTE: This returns similar flags to fsync(fd, F_GETFL) in POSIX, as well as additional fields.

fn fd_fdstat_set_flags( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, flags: Fdflags, ) -> Result<(), Error>

Adjust the flags associated with a file descriptor. NOTE: This is similar to fcntl(fd, F_SETFL, flags) in POSIX.

fn fd_fdstat_set_rights( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, _fs_rights_base: Rights, _fs_rights_inheriting: Rights, ) -> Result<(), Error>

Does not do anything if fd corresponds to a valid descriptor and returns [types::Errno::Badf] error otherwise.

async fn fd_filestat_get( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, ) -> Result<Filestat, Error>

Return the attributes of an open file.

async fn fd_filestat_set_size( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, size: Filesize, ) -> Result<(), Error>

Adjust the size of an open file. If this increases the file’s size, the extra bytes are filled with zeros. NOTE: This is similar to ftruncate in POSIX.

async fn fd_filestat_set_times( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, atim: Timestamp, mtim: Timestamp, fst_flags: Fstflags, ) -> Result<(), Error>

Adjust the timestamps of an open file or directory. NOTE: This is similar to futimens in POSIX.

async fn fd_read( &mut self, memory: &mut GuestMemory<'_>, fd: Fd, iovs: IovecArray, ) -> Result<Size, Error>

Read from a file descriptor. NOTE: This is similar to readv in POSIX.

async fn fd_pread( &mut self, memory: &mut GuestMemory<'_>, fd: Fd, iovs: IovecArray, offset: Filesize, ) -> Result<Size, Error>

Read from a file descriptor, without using and updating the file descriptor’s offset. NOTE: This is similar to preadv in POSIX.

async fn fd_write( &mut self, memory: &mut GuestMemory<'_>, fd: Fd, ciovs: CiovecArray, ) -> Result<Size, Error>

Write to a file descriptor. NOTE: This is similar to writev in POSIX.

async fn fd_pwrite( &mut self, memory: &mut GuestMemory<'_>, fd: Fd, ciovs: CiovecArray, offset: Filesize, ) -> Result<Size, Error>

Write to a file descriptor, without using and updating the file descriptor’s offset. NOTE: This is similar to pwritev in POSIX.

fn fd_prestat_get( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, ) -> Result<Prestat, Error>

Return a description of the given preopened file descriptor.

fn fd_prestat_dir_name( &mut self, memory: &mut GuestMemory<'_>, fd: Fd, path: GuestPtr<u8>, path_max_len: Size, ) -> Result<(), Error>

Return a description of the given preopened file descriptor.

fn fd_renumber( &mut self, _memory: &mut GuestMemory<'_>, from: Fd, to: Fd, ) -> Result<(), Error>

Atomically replace a file descriptor by renumbering another file descriptor.

async fn fd_seek( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, offset: Filedelta, whence: Whence, ) -> Result<Filesize, Error>

Move the offset of a file descriptor. NOTE: This is similar to lseek in POSIX.

async fn fd_sync( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, ) -> Result<(), Error>

Synchronize the data and metadata of a file to disk. NOTE: This is similar to fsync in POSIX.

fn fd_tell( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, ) -> Result<Filesize, Error>

Return the current offset of a file descriptor. NOTE: This is similar to lseek(fd, 0, SEEK_CUR) in POSIX.

async fn path_filestat_get( &mut self, memory: &mut GuestMemory<'_>, dirfd: Fd, flags: Lookupflags, path: GuestPtr<str>, ) -> Result<Filestat, Error>

Return the attributes of a file or directory. NOTE: This is similar to stat in POSIX.

async fn path_filestat_set_times( &mut self, memory: &mut GuestMemory<'_>, dirfd: Fd, flags: Lookupflags, path: GuestPtr<str>, atim: Timestamp, mtim: Timestamp, fst_flags: Fstflags, ) -> Result<(), Error>

Adjust the timestamps of a file or directory. NOTE: This is similar to utimensat in POSIX.

async fn path_link( &mut self, memory: &mut GuestMemory<'_>, src_fd: Fd, src_flags: Lookupflags, src_path: GuestPtr<str>, target_fd: Fd, target_path: GuestPtr<str>, ) -> Result<(), Error>

Create a hard link. NOTE: This is similar to linkat in POSIX.

async fn path_open( &mut self, memory: &mut GuestMemory<'_>, dirfd: Fd, dirflags: Lookupflags, path: GuestPtr<str>, oflags: Oflags, fs_rights_base: Rights, _fs_rights_inheriting: Rights, fdflags: Fdflags, ) -> Result<Fd, Error>

Open a file or directory. NOTE: This is similar to openat in POSIX.

async fn path_readlink( &mut self, memory: &mut GuestMemory<'_>, dirfd: Fd, path: GuestPtr<str>, buf: GuestPtr<u8>, buf_len: Size, ) -> Result<Size, Error>

Read the contents of a symbolic link. NOTE: This is similar to readlinkat in POSIX.

async fn path_rename( &mut self, memory: &mut GuestMemory<'_>, src_fd: Fd, src_path: GuestPtr<str>, dest_fd: Fd, dest_path: GuestPtr<str>, ) -> Result<(), Error>

Rename a file or directory. NOTE: This is similar to renameat in POSIX.

fn args_get( &mut self, memory: &mut GuestMemory<'_>, argv: GuestPtr<GuestPtr<u8>>, argv_buf: GuestPtr<u8>, ) -> Result<(), Error>

fn args_sizes_get( &mut self, _memory: &mut GuestMemory<'_>, ) -> Result<(Size, Size), Error>

fn environ_get( &mut self, memory: &mut GuestMemory<'_>, environ: GuestPtr<GuestPtr<u8>>, environ_buf: GuestPtr<u8>, ) -> Result<(), Error>

fn environ_sizes_get( &mut self, _memory: &mut GuestMemory<'_>, ) -> Result<(Size, Size), Error>

fn clock_res_get( &mut self, _memory: &mut GuestMemory<'_>, id: Clockid, ) -> Result<Timestamp, Error>

fn clock_time_get( &mut self, _memory: &mut GuestMemory<'_>, id: Clockid, _precision: Timestamp, ) -> Result<Timestamp, Error>

async fn fd_advise( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, offset: Filesize, len: Filesize, advice: Advice, ) -> Result<(), Error>

async fn fd_readdir( &mut self, memory: &mut GuestMemory<'_>, fd: Fd, buf: GuestPtr<u8>, buf_len: Size, cookie: Dircookie, ) -> Result<Size, Error>

async fn path_create_directory( &mut self, memory: &mut GuestMemory<'_>, dirfd: Fd, path: GuestPtr<str>, ) -> Result<(), Error>

async fn path_remove_directory( &mut self, memory: &mut GuestMemory<'_>, dirfd: Fd, path: GuestPtr<str>, ) -> Result<(), Error>

async fn path_symlink( &mut self, memory: &mut GuestMemory<'_>, src_path: GuestPtr<str>, dirfd: Fd, dest_path: GuestPtr<str>, ) -> Result<(), Error>

async fn path_unlink_file( &mut self, memory: &mut GuestMemory<'_>, dirfd: Fd, path: GuestPtr<str>, ) -> Result<(), Error>

async fn poll_oneoff( &mut self, memory: &mut GuestMemory<'_>, subs: GuestPtr<Subscription>, events: GuestPtr<Event>, nsubscriptions: Size, ) -> Result<Size, Error>

fn proc_exit( &mut self, _memory: &mut GuestMemory<'_>, status: Exitcode, ) -> Error

fn proc_raise( &mut self, _memory: &mut GuestMemory<'_>, _sig: Signal, ) -> Result<(), Error>

fn sched_yield(&mut self, _memory: &mut GuestMemory<'_>) -> Result<(), Error>

fn random_get( &mut self, memory: &mut GuestMemory<'_>, buf: GuestPtr<u8>, buf_len: Size, ) -> Result<(), Error>

fn sock_accept( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, flags: Fdflags, ) -> Result<Fd, Error>

fn sock_recv( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, ri_data: IovecArray, ri_flags: Riflags, ) -> Result<(Size, Roflags), Error>

fn sock_send( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, si_data: CiovecArray, _si_flags: Siflags, ) -> Result<Size, Error>

fn sock_shutdown( &mut self, _memory: &mut GuestMemory<'_>, fd: Fd, how: Sdflags, ) -> Result<(), Error>

impl WasiView for WasiP1Ctx

fn ctx(&mut self) -> WasiCtxView<'_>

Yields mutable access to the WasiCtx configuration used for this context.