Struct wasmer_wasi::WasiFs

pub struct WasiFs {
    pub preopen_fds: Vec<u32>,
    pub name_map: HashMap<String, Inode>,
    pub inodes: Arena<InodeVal>,
    pub fd_map: HashMap<u32, Fd>,
    pub next_fd: Cell<u32>,
    pub orphan_fds: HashMap<Inode, InodeVal>,
    // some fields omitted
}

Warning, modifying these fields directly may cause invariants to break and should be considered unsafe. These fields may be made private in a future release

Fields

preopen_fds: Vec<u32>

name_map: HashMap<String, Inode>

inodes: Arena<InodeVal>

fd_map: HashMap<u32, Fd>

next_fd: Cell<u32>

orphan_fds: HashMap<Inode, InodeVal>

for fds still open after the file has been deleted

Implementations

impl WasiFs

pub fn new(
    preopened_dirs: &[PathBuf],
    mapped_dirs: &[(String, PathBuf)]
) -> Result<Self, String>

👎 Deprecated since 0.14.0:

This method will change or be made private in the future. Please use WasiState::new and the builder API instead.

Internal function for constructing a WasiFs. Please use WasiState::new.

pub fn stdout(&self) -> Result<&Option<Box<dyn WasiFile>>, WasiFsError>

Get the WasiFile object at stdout

pub fn stdout_mut(
    &mut self
) -> Result<&mut Option<Box<dyn WasiFile>>, WasiFsError>

Get the WasiFile object at stdout mutably

pub fn stderr(&self) -> Result<&Option<Box<dyn WasiFile>>, WasiFsError>

Get the WasiFile object at stderr

pub fn stderr_mut(
    &mut self
) -> Result<&mut Option<Box<dyn WasiFile>>, WasiFsError>

Get the WasiFile object at stderr mutably

pub fn stdin(&self) -> Result<&Option<Box<dyn WasiFile>>, WasiFsError>

Get the WasiFile object at stdin

pub fn stdin_mut(
    &mut self
) -> Result<&mut Option<Box<dyn WasiFile>>, WasiFsError>

Get the WasiFile object at stdin mutably

pub unsafe fn open_dir_all(
    &mut self,
    base: __wasi_fd_t,
    name: String,
    rights: __wasi_rights_t,
    rights_inheriting: __wasi_rights_t,
    flags: __wasi_fdflags_t
) -> Result<__wasi_fd_t, WasiFsError>

This function is like create dir all, but it also opens it. Function is unsafe because it may break invariants and hasn't been tested. This is an experimental function and may be removed

Safety

• Virtual directories created with this function must not conflict with the standard operation of the WASI filesystem. This is vague and unlikely in pratice. Join the discussion for what the newer, safer WASI FS APIs should look like.

pub fn open_file_at(
    &mut self,
    base: __wasi_fd_t,
    file: Box<dyn WasiFile>,
    open_flags: u16,
    name: String,
    rights: __wasi_rights_t,
    rights_inheriting: __wasi_rights_t,
    flags: __wasi_fdflags_t
) -> Result<__wasi_fd_t, WasiFsError>

Opens a user-supplied file in the directory specified with the name and flags given

pub fn swap_file(
    &mut self,
    fd: __wasi_fd_t,
    file: Box<dyn WasiFile>
) -> Result<Option<Box<dyn WasiFile>>, WasiFsError>

Change the backing of a given file descriptor Returns the old backing TODO: add examples

pub fn get_fd(&self, fd: __wasi_fd_t) -> Result<&Fd, __wasi_errno_t>

pub fn get_inodeval_mut(
    &mut self,
    fd: __wasi_fd_t
) -> Result<&mut InodeVal, __wasi_errno_t>

gets either a normal inode or an orphaned inode

pub fn filestat_fd(
    &self,
    fd: __wasi_fd_t
) -> Result<__wasi_filestat_t, __wasi_errno_t>

pub fn fdstat(&self, fd: __wasi_fd_t) -> Result<__wasi_fdstat_t, __wasi_errno_t>

pub fn prestat_fd(
    &self,
    fd: __wasi_fd_t
) -> Result<__wasi_prestat_t, __wasi_errno_t>

pub fn flush(&mut self, fd: __wasi_fd_t) -> Result<(), __wasi_errno_t>

pub fn create_fd(
    &mut self,
    rights: __wasi_rights_t,
    rights_inheriting: __wasi_rights_t,
    flags: __wasi_fdflags_t,
    open_flags: u16,
    inode: Inode
) -> Result<__wasi_fd_t, __wasi_errno_t>

pub unsafe fn remove_inode(&mut self, inode: Inode) -> Option<InodeVal>

Low level function to remove an inode, that is it deletes the WASI FS's knowledge of a file.

This function returns the inode if it existed and was removed.

Safety

• The caller must ensure that all references to the specified inode have been removed from the filesystem.

pub fn get_stat_for_kind(&self, kind: &Kind) -> Option<__wasi_filestat_t>

Trait Implementations

impl Debug for WasiFs

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WasiFs

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for WasiFs

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.