Struct wasi_common::OsDir

pub struct OsDir { /* fields omitted */ }

A directory in the operating system's file system. Its impl of Handle is in sys::osdir. This type is exposed to all other modules as sys::osdir::OsDir when configured.

Constructing OsDir

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

use std::fs::OpenOptions;
use std::convert::TryFrom;
use std::os::windows::fs::OpenOptionsExt;
use wasi_common::OsDir;
use winapi::um::winbase::FILE_FLAG_BACKUP_SEMANTICS;

let dir = OpenOptions::new().read(true).attributes(FILE_FLAG_BACKUP_SEMANTICS).open("some_dir").unwrap();
let os_dir = OsDir::try_from(dir).unwrap();

Trait Implementations

impl Debug for OsDir

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Deref for OsDir

type Target = RawOsHandle

The resulting type after dereferencing.

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

Dereferences the value.

impl Handle for OsDir

fn as_any(&self) -> &dyn Any

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

fn get_file_type(&self) -> Filetype

fn get_rights(&self) -> HandleRights

fn set_rights(&self, rights: HandleRights)

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

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

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

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

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

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

fn filestat_get_at(&self, path: &str, follow: bool) -> Result<Filestat>

fn filestat_set_times_at(
    &self,
    path: &str,
    atim: Timestamp,
    mtim: Timestamp,
    fst_flags: Fstflags,
    follow: bool
) -> Result<()>

fn openat(
    &self,
    path: &str,
    read: bool,
    write: bool,
    oflags: Oflags,
    fd_flags: Fdflags
) -> Result<Box<dyn Handle>>

fn link(
    &self,
    old_path: &str,
    new_handle: Box<dyn Handle>,
    new_path: &str,
    follow: bool
) -> Result<()>

fn symlink(&self, old_path: &str, new_path: &str) -> Result<()>

fn readlink(&self, path: &str, buf: &mut [u8]) -> Result<usize>

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

fn rename(
    &self,
    old_path: &str,
    new_handle: Box<dyn Handle>,
    new_path: &str
) -> Result<()>

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

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

fn is_directory(&self) -> bool

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.

fn advise(
    &self,
    _advice: Advice,
    _offset: Filesize,
    _len: Filesize
) -> Result<()>

fn allocate(&self, _offset: Filesize, _len: Filesize) -> Result<()>

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

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

fn preadv(&self, _buf: &mut [IoSliceMut], _offset: u64) -> Result<usize>

fn pwritev(&self, _buf: &[IoSlice], _offset: u64) -> Result<usize>

fn read_vectored(&self, _iovs: &mut [IoSliceMut]) -> Result<usize>

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

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

fn write_vectored(&self, _iovs: &[IoSlice]) -> Result<usize>

impl TryFrom<File> for OsDir

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.