Struct wasi_common::OsFile

pub struct OsFile { /* fields omitted */ }

A file backed by the operating system's file system. Dereferences to a RawOsHandle. Its impl of Handle uses Rust's std to implement all file descriptor operations.

Constructing OsFile

OsFile can currently only be constructed from std::fs::File using the std::convert::TryFrom trait:

use std::fs::OpenOptions;
use std::convert::TryFrom;
use wasi_common::OsFile;

let file = OpenOptions::new().read(true).open("some_file").unwrap();
let os_file = OsFile::try_from(file).unwrap();

Trait Implementations

impl Debug for OsFile

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

Formats the value using the given formatter.

impl Deref for OsFile

type Target = RawOsHandle

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.

impl Handle for OsFile

pub fn as_any(&self) -> &dyn Any

pub fn try_clone(&self) -> Result<Box<dyn Handle>>

pub fn get_file_type(&self) -> Filetype

pub fn get_rights(&self) -> HandleRights

pub fn set_rights(&self, rights: HandleRights)

pub fn advise(
    &self,
    advice: Advice,
    offset: Filesize,
    len: Filesize
) -> Result<()>

pub fn allocate(&self, offset: Filesize, len: Filesize) -> Result<()>

pub fn datasync(&self) -> Result<()>

pub fn fdstat_get(&self) -> Result<Fdflags>

pub fn fdstat_set_flags(&self, fdflags: Fdflags) -> Result<()>

pub fn filestat_get(&self) -> Result<Filestat>

pub fn filestat_set_size(&self, size: Filesize) -> Result<()>

pub fn filestat_set_times(
    &self,
    atim: Timestamp,
    mtim: Timestamp,
    fst_flags: Fstflags
) -> Result<()>

pub fn preadv(&self, buf: &mut [IoSliceMut<'_>], offset: u64) -> Result<usize>

pub fn pwritev(&self, buf: &[IoSlice<'_>], offset: u64) -> Result<usize>

pub fn read_vectored(&self, iovs: &mut [IoSliceMut<'_>]) -> Result<usize>

pub fn seek(&self, offset: SeekFrom) -> Result<u64>

pub fn sync(&self) -> Result<()>

pub fn write_vectored(&self, iovs: &[IoSlice<'_>]) -> Result<usize>

pub fn is_directory(&self) -> bool

pub fn is_tty(&self) -> bool

Test whether this descriptor is considered a tty within WASI. Note that since WASI itself lacks an isatty syscall and relies on a conservative approximation, we use the same approximation here.

pub fn readdir<'a>(
    &'a self,
    _cookie: Dircookie
) -> Result<Box<dyn Iterator<Item = Result<(Dirent, String)>> + 'a>>

pub fn create_directory(&self, _path: &str) -> Result<()>

pub fn filestat_get_at(&self, _path: &str, _follow: bool) -> Result<Filestat>

pub fn filestat_set_times_at(
    &self,
    _path: &str,
    _atim: Timestamp,
    _mtim: Timestamp,
    _fst_flags: Fstflags,
    _follow: bool
) -> Result<()>

pub fn openat(
    &self,
    _path: &str,
    _read: bool,
    _write: bool,
    _oflags: Oflags,
    _fd_flags: Fdflags
) -> Result<Box<dyn Handle>>

pub fn link(
    &self,
    _old_path: &str,
    _new_handle: Box<dyn Handle>,
    _new_path: &str,
    _follow: bool
) -> Result<()>

pub fn readlink(&self, _path: &str, _buf: &mut [u8]) -> Result<usize>

pub fn readlinkat(&self, _path: &str) -> Result<String>

pub fn remove_directory(&self, _path: &str) -> Result<()>

pub fn rename(
    &self,
    _old_path: &str,
    _new_handle: Box<dyn Handle>,
    _new_path: &str
) -> Result<()>

pub fn symlink(&self, _old_path: &str, _new_path: &str) -> Result<()>

pub fn unlink_file(&self, _path: &str) -> Result<()>

impl TryFrom<File> for OsFile

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(file: File) -> Result<Self>

Performs the conversion.