Struct IncludeDirVfs 

pub struct IncludeDirVfs { /* private fields */ }

A Vfs implementation with an include_dir::Dir directory.

Implementations

impl IncludeDirVfs

pub fn new(dir: Dir<'static>) -> Self

Creates a new IncludeDirVfs.

Trait Implementations

impl<'vfs> Vfs<'vfs> for IncludeDirVfs

type DirWalk<'a> = IncludeDirWalker<'a> where Self: 'a, 'vfs: 'a

The type of the directory walker returned by the walk_dir method.

type RFile = Cursor<&'static [u8]>

The type of the file returned by the open_read method. This allows us to read a file in chunks, which might be required for some certain file formats.

fn open_read(self: Pin<&Self>, path: &Path) -> VfsResult<Self::RFile, Self>

Opens a file for reading, at the specified path.

fn read(self: Pin<&Self>, path: &Path) -> VfsResult<Vec<u8>, Self>

Reads the contents of a file, at the specified path. This is a core method that all other read methods are built upon, except for the ones that read via open_read and RFile.

fn read_string(self: Pin<&Self>, path: &Path) -> VfsResult<String, Self>

Reads the contents of a file, at the specified path, and returns it as a string.

fn exists(self: Pin<&Self>, path: &Path) -> VfsResult<bool, Self>

Checks if a file exists at the specified path.

fn is_dir(self: Pin<&Self>, path: &Self::Path) -> VfsResult<bool, Self>

Checks if a directory exists at the specified path.

fn walk_dir<'b>( self: Pin<&'b Self>, path: &Path, ) -> VfsResult<Self::DirWalk<'b>, Self>

where 'vfs: 'b,

Walks a directory at the specified path, returning a stream of directory entries.

impl VfsCore for IncludeDirVfs

type Path = Path

The path type used to represent paths in this virtual file system.