Struct vfs_clgit::CommitFS

pub struct CommitFS { /* fields omitted */ }

A read-only filesystem for a single git Commit

Example

let commitfs = CommitFS::new(".", "dcb6ca6b041186b6aeb17b9bce48ce2ae112b7dc").unwrap();
let commitfs = VfsPath::new(commitfs);
// ...

Implementations

impl CommitFS

pub fn new(
    repository: impl TryIntoSharedRepositoryCache,
    commit: impl TryIntoCommitHash
) -> Result<Self>

Create a filesystem over a commit.

Trait Implementations

impl Debug for CommitFS

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

Formats the value using the given formatter.

impl FileSystem for CommitFS

fn read_dir(&self, path: &str) -> VfsResult<Box<dyn Iterator<Item = String>>>

Iterates over all entries of this directory path

fn open_file(&self, path: &str) -> VfsResult<Box<dyn SeekAndRead>>

Opens the file at this path for reading

fn metadata(&self, path: &str) -> VfsResult<VfsMetadata>

Returns the file metadata for the file at this path

fn exists(&self, path: &str) -> bool

Returns true if a file or directory at path exists, false otherwise

fn create_dir(&self, _path: &str) -> VfsResult<()>

Creates the directory at this path

fn create_file(&self, _path: &str) -> VfsResult<Box<dyn Write>>

Creates a file at this path for writing

fn append_file(&self, _path: &str) -> VfsResult<Box<dyn Write>>

Opens the file at this path for appending

fn remove_file(&self, _path: &str) -> VfsResult<()>

Removes the file at this path

fn remove_dir(&self, _path: &str) -> VfsResult<()>

Removes the directory at this path

fn copy_file(&self, _src: &str, _dst: &str) -> VfsResult<()>

Copies the src path to the destination path within the same filesystem (optional)

fn move_file(&self, _src: &str, _dst: &str) -> VfsResult<()>

Moves the src path to the destination path within the same filesystem (optional)

fn move_dir(&self, _src: &str, _dst: &str) -> VfsResult<()>

Moves the src directory to the destination path within the same filesystem (optional)