Struct GitVfs 

pub struct GitVfs<'r> { /* private fields */ }

Available on crate feature git only.

A virtual filesystem that reads from a git repository.

Implementations

impl<'r> GitVfs<'r>

pub fn new(repo: &'r Repository, tree: Tree<'r>) -> Self

Create a new GitVfs from a git repository and a tree.

Trait Implementations

impl<'r> Vfs<'r> for GitVfs<'r>

type DirWalk<'a> = GitDirWalk where Self: 'a, 'r: 'a

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

type RFile = GitRFile<'r>

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 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<'a>( self: Pin<&'a Self>, path: &Path, ) -> VfsResult<Self::DirWalk<'a>, Self>

where 'r: 'a,

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

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

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

impl<'r> VfsCore for GitVfs<'r>

type Path = Path

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