Trait VirtualFileSystem 

pub trait VirtualFileSystem {
    // Required methods
    fn read_file(&mut self, path: &str) -> VfsResult<Vec<u8>>;
    fn read_dir(&mut self, path: &str) -> VfsResult<Vec<String>>;
    fn read_dir_with_types(
        &mut self,
        path: &str,
    ) -> VfsResult<Vec<VirtualDirEntry>>;
    fn write_file(
        &mut self,
        path: &str,
        content: impl Into<Vec<u8>>,
    ) -> VfsResult<()>;
    fn create_dir(&mut self, path: &str) -> VfsResult<()>;
    fn mkdir(&mut self, path: &str, recursive: bool) -> VfsResult<()>;
    fn exists(&self, path: &str) -> bool;
    fn stat(&mut self, path: &str) -> VfsResult<VirtualStat>;
    fn remove_file(&mut self, path: &str) -> VfsResult<()>;
    fn remove_dir(&mut self, path: &str) -> VfsResult<()>;
    fn rename(&mut self, old_path: &str, new_path: &str) -> VfsResult<()>;
    fn realpath(&self, path: &str) -> VfsResult<String>;
    fn symlink(&mut self, target: &str, link_path: &str) -> VfsResult<()>;
    fn read_link(&self, path: &str) -> VfsResult<String>;
    fn lstat(&self, path: &str) -> VfsResult<VirtualStat>;
    fn link(&mut self, old_path: &str, new_path: &str) -> VfsResult<()>;
    fn chmod(&mut self, path: &str, mode: u32) -> VfsResult<()>;
    fn chown(&mut self, path: &str, uid: u32, gid: u32) -> VfsResult<()>;
    fn utimes(
        &mut self,
        path: &str,
        atime_ms: u64,
        mtime_ms: u64,
    ) -> VfsResult<()>;
    fn truncate(&mut self, path: &str, length: u64) -> VfsResult<()>;
    fn pread(
        &mut self,
        path: &str,
        offset: u64,
        length: usize,
    ) -> VfsResult<Vec<u8>>;

    // Provided methods
    fn read_text_file(&mut self, path: &str) -> VfsResult<String> { ... }
    fn read_dir_limited(
        &mut self,
        path: &str,
        max_entries: usize,
    ) -> VfsResult<Vec<String>> { ... }
    fn write_file_with_mode(
        &mut self,
        path: &str,
        content: impl Into<Vec<u8>>,
        mode: Option<u32>,
    ) -> VfsResult<()> { ... }
    fn create_file_exclusive(
        &mut self,
        path: &str,
        content: impl Into<Vec<u8>>,
    ) -> VfsResult<()> { ... }
    fn create_file_exclusive_with_mode(
        &mut self,
        path: &str,
        content: impl Into<Vec<u8>>,
        mode: Option<u32>,
    ) -> VfsResult<()> { ... }
    fn append_file(
        &mut self,
        path: &str,
        content: impl Into<Vec<u8>>,
    ) -> VfsResult<u64> { ... }
    fn create_dir_with_mode(
        &mut self,
        path: &str,
        mode: Option<u32>,
    ) -> VfsResult<()> { ... }
    fn mknod(&mut self, path: &str, mode: u32, rdev: u64) -> VfsResult<()> { ... }
    fn mkdir_with_mode(
        &mut self,
        path: &str,
        recursive: bool,
        mode: Option<u32>,
    ) -> VfsResult<()> { ... }
    fn rename_at2(
        &mut self,
        old_path: &str,
        new_path: &str,
        flags: u32,
    ) -> VfsResult<()> { ... }
    fn chown_spec(
        &mut self,
        path: &str,
        uid: u32,
        gid: u32,
        follow_symlinks: bool,
    ) -> VfsResult<()> { ... }
    fn lchown(&mut self, path: &str, uid: u32, gid: u32) -> VfsResult<()> { ... }
    fn get_xattr(
        &mut self,
        path: &str,
        name: &str,
        follow_symlinks: bool,
    ) -> VfsResult<Vec<u8>> { ... }
    fn list_xattrs(
        &mut self,
        path: &str,
        follow_symlinks: bool,
    ) -> VfsResult<Vec<String>> { ... }
    fn set_xattr(
        &mut self,
        path: &str,
        name: &str,
        value: Vec<u8>,
        flags: u32,
        follow_symlinks: bool,
    ) -> VfsResult<()> { ... }
    fn remove_xattr(
        &mut self,
        path: &str,
        name: &str,
        follow_symlinks: bool,
    ) -> VfsResult<()> { ... }
    fn utimes_spec(
        &mut self,
        path: &str,
        atime: VirtualUtimeSpec,
        mtime: VirtualUtimeSpec,
        follow_symlinks: bool,
    ) -> VfsResult<()> { ... }
    fn sync(&mut self, _path: &str) -> VfsResult<()> { ... }
    fn allocate(
        &mut self,
        path: &str,
        offset: u64,
        length: u64,
    ) -> VfsResult<()> { ... }
    fn insert_range(
        &mut self,
        path: &str,
        offset: u64,
        length: u64,
    ) -> VfsResult<()> { ... }
    fn collapse_range(
        &mut self,
        path: &str,
        offset: u64,
        length: u64,
    ) -> VfsResult<()> { ... }
    fn zero_range(
        &mut self,
        path: &str,
        offset: u64,
        length: u64,
        keep_size: bool,
    ) -> VfsResult<()> { ... }
    fn punch_hole(
        &mut self,
        path: &str,
        offset: u64,
        length: u64,
    ) -> VfsResult<()> { ... }
    fn allocated_ranges(&mut self, path: &str) -> VfsResult<Vec<(u64, u64)>> { ... }
    fn unwritten_ranges(&mut self, _path: &str) -> VfsResult<Vec<(u64, u64)>> { ... }
    fn pwrite(
        &mut self,
        path: &str,
        content: impl Into<Vec<u8>>,
        offset: u64,
    ) -> VfsResult<()> { ... }
}

Required Methods

fn read_file(&mut self, path: &str) -> VfsResult<Vec<u8>>

fn read_dir(&mut self, path: &str) -> VfsResult<Vec<String>>

fn read_dir_with_types(&mut self, path: &str) -> VfsResult<Vec<VirtualDirEntry>>

fn write_file( &mut self, path: &str, content: impl Into<Vec<u8>>, ) -> VfsResult<()>

Writes caller-owned bytes into the filesystem.

This raw VFS primitive does not enforce VM resource policy. Kernel entry points must preflight file sizes and inode growth before calling it.

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

fn mkdir(&mut self, path: &str, recursive: bool) -> VfsResult<()>

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

fn stat(&mut self, path: &str) -> VfsResult<VirtualStat>

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

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

fn rename(&mut self, old_path: &str, new_path: &str) -> VfsResult<()>

fn realpath(&self, path: &str) -> VfsResult<String>

fn symlink(&mut self, target: &str, link_path: &str) -> VfsResult<()>

fn read_link(&self, path: &str) -> VfsResult<String>

fn lstat(&self, path: &str) -> VfsResult<VirtualStat>

fn link(&mut self, old_path: &str, new_path: &str) -> VfsResult<()>

fn chmod(&mut self, path: &str, mode: u32) -> VfsResult<()>

fn chown(&mut self, path: &str, uid: u32, gid: u32) -> VfsResult<()>

fn utimes(&mut self, path: &str, atime_ms: u64, mtime_ms: u64) -> VfsResult<()>

fn truncate(&mut self, path: &str, length: u64) -> VfsResult<()>

Resizes a file. VM resource policy must be enforced by the caller.

fn pread( &mut self, path: &str, offset: u64, length: usize, ) -> VfsResult<Vec<u8>>

Provided Methods

fn read_text_file(&mut self, path: &str) -> VfsResult<String>

fn read_dir_limited( &mut self, path: &str, max_entries: usize, ) -> VfsResult<Vec<String>>

fn write_file_with_mode( &mut self, path: &str, content: impl Into<Vec<u8>>, mode: Option<u32>, ) -> VfsResult<()>

fn create_file_exclusive( &mut self, path: &str, content: impl Into<Vec<u8>>, ) -> VfsResult<()>

fn create_file_exclusive_with_mode( &mut self, path: &str, content: impl Into<Vec<u8>>, mode: Option<u32>, ) -> VfsResult<()>

fn append_file( &mut self, path: &str, content: impl Into<Vec<u8>>, ) -> VfsResult<u64>

Appends caller-owned bytes into the filesystem after checking that the in-memory file can grow without overflowing addressable memory.

fn create_dir_with_mode( &mut self, path: &str, mode: Option<u32>, ) -> VfsResult<()>

fn mknod(&mut self, path: &str, mode: u32, rdev: u64) -> VfsResult<()>

fn mkdir_with_mode( &mut self, path: &str, recursive: bool, mode: Option<u32>, ) -> VfsResult<()>

fn rename_at2( &mut self, old_path: &str, new_path: &str, flags: u32, ) -> VfsResult<()>

fn chown_spec( &mut self, path: &str, uid: u32, gid: u32, follow_symlinks: bool, ) -> VfsResult<()>

fn lchown(&mut self, path: &str, uid: u32, gid: u32) -> VfsResult<()>

fn get_xattr( &mut self, path: &str, name: &str, follow_symlinks: bool, ) -> VfsResult<Vec<u8>>

fn list_xattrs( &mut self, path: &str, follow_symlinks: bool, ) -> VfsResult<Vec<String>>

fn set_xattr( &mut self, path: &str, name: &str, value: Vec<u8>, flags: u32, follow_symlinks: bool, ) -> VfsResult<()>

fn remove_xattr( &mut self, path: &str, name: &str, follow_symlinks: bool, ) -> VfsResult<()>

fn utimes_spec( &mut self, path: &str, atime: VirtualUtimeSpec, mtime: VirtualUtimeSpec, follow_symlinks: bool, ) -> VfsResult<()>

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

fn allocate(&mut self, path: &str, offset: u64, length: u64) -> VfsResult<()>

Allocates storage for a range without changing existing bytes. VM resource policy must be enforced by the caller.

fn insert_range( &mut self, path: &str, offset: u64, length: u64, ) -> VfsResult<()>

fn collapse_range( &mut self, path: &str, offset: u64, length: u64, ) -> VfsResult<()>

fn zero_range( &mut self, path: &str, offset: u64, length: u64, keep_size: bool, ) -> VfsResult<()>

Zeroes and allocates a byte range, optionally preserving the file size.

fn punch_hole(&mut self, path: &str, offset: u64, length: u64) -> VfsResult<()>

Deallocates a byte range while preserving the file size. Bytes in the intersecting range read back as zeroes.

fn allocated_ranges(&mut self, path: &str) -> VfsResult<Vec<(u64, u64)>>

Returns allocated byte ranges as half-open (start, end) intervals.

fn unwritten_ranges(&mut self, _path: &str) -> VfsResult<Vec<(u64, u64)>>

Returns allocated byte ranges whose contents are logically zero until first written, as half-open (start, end) intervals.

fn pwrite( &mut self, path: &str, content: impl Into<Vec<u8>>, offset: u64, ) -> VfsResult<()>

Writes caller-owned bytes at an offset after checking that the in-memory file can grow without overflowing addressable memory.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl VirtualFileSystem for MemoryFileSystem

impl VirtualFileSystem for MountTable

impl VirtualFileSystem for OverlayFileSystem

impl VirtualFileSystem for RootFileSystem

impl VirtualFileSystem for SingleSymlinkFileSystem

impl VirtualFileSystem for TarFileSystem