Trait Scheme 

pub trait Scheme: Send + Sync {
    // Required methods
    fn open(
        &self,
        path: &str,
        flags: OpenFlags,
    ) -> Result<OpenResult, SyscallError>;
    fn read(
        &self,
        file_id: u64,
        offset: u64,
        buf: &mut [u8],
    ) -> Result<usize, SyscallError>;
    fn write(
        &self,
        file_id: u64,
        offset: u64,
        buf: &[u8],
    ) -> Result<usize, SyscallError>;
    fn close(&self, file_id: u64) -> Result<(), SyscallError>;

    // Provided methods
    fn size(&self, file_id: u64) -> Result<u64, SyscallError> { ... }
    fn truncate(&self, file_id: u64, new_size: u64) -> Result<(), SyscallError> { ... }
    fn sync(&self, file_id: u64) -> Result<(), SyscallError> { ... }
    fn create_file(
        &self,
        path: &str,
        mode: u32,
    ) -> Result<OpenResult, SyscallError> { ... }
    fn create_directory(
        &self,
        path: &str,
        mode: u32,
    ) -> Result<OpenResult, SyscallError> { ... }
    fn unlink(&self, path: &str) -> Result<(), SyscallError> { ... }
    fn stat(&self, file_id: u64) -> Result<FileStat, SyscallError> { ... }
    fn readdir(&self, file_id: u64) -> Result<Vec<DirEntry>, SyscallError> { ... }
    fn rename(&self, old_path: &str, new_path: &str) -> Result<(), SyscallError> { ... }
    fn chmod(&self, path: &str, mode: u32) -> Result<(), SyscallError> { ... }
    fn fchmod(&self, file_id: u64, mode: u32) -> Result<(), SyscallError> { ... }
    fn link(&self, old_path: &str, new_path: &str) -> Result<(), SyscallError> { ... }
    fn symlink(&self, target: &str, link_path: &str) -> Result<(), SyscallError> { ... }
    fn readlink(&self, path: &str) -> Result<String, SyscallError> { ... }
}

Abstraction for a filesystem/service backend.

Required Methods

fn open(&self, path: &str, flags: OpenFlags) -> Result<OpenResult, SyscallError>

Open a file/resource at the given path within this scheme.

path is relative to the scheme’s mount point. Returns a unique file handle + metadata.

fn read( &self, file_id: u64, offset: u64, buf: &mut [u8], ) -> Result<usize, SyscallError>

Read bytes from an open file.

fn write( &self, file_id: u64, offset: u64, buf: &[u8], ) -> Result<usize, SyscallError>

Write bytes to an open file.

fn close(&self, file_id: u64) -> Result<(), SyscallError>

Close an open file.

Provided Methods

fn size(&self, file_id: u64) -> Result<u64, SyscallError>

Get file size (if supported).

fn truncate(&self, file_id: u64, new_size: u64) -> Result<(), SyscallError>

Truncate/resize a file (if supported).

fn sync(&self, file_id: u64) -> Result<(), SyscallError>

Sync file to storage (if applicable).

fn create_file(&self, path: &str, mode: u32) -> Result<OpenResult, SyscallError>

Create a new regular file.

fn create_directory( &self, path: &str, mode: u32, ) -> Result<OpenResult, SyscallError>

Create a new directory.

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

Remove a file or directory.

fn stat(&self, file_id: u64) -> Result<FileStat, SyscallError>

Get metadata for an open file.

fn readdir(&self, file_id: u64) -> Result<Vec<DirEntry>, SyscallError>

Read directory entries from an open directory handle.

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

Rename/move an entry within this scheme.

fn chmod(&self, path: &str, mode: u32) -> Result<(), SyscallError>

Change permission bits on a path.

fn fchmod(&self, file_id: u64, mode: u32) -> Result<(), SyscallError>

Change permission bits on an open file handle.

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

Create a hard link.

fn symlink(&self, target: &str, link_path: &str) -> Result<(), SyscallError>

Create a symbolic link.

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

Read the target of a symbolic link.

Implementors

impl Scheme for NetScheme

impl Scheme for BlkDevScheme

impl Scheme for ConsoleScheme

impl Scheme for IpcControlScheme

impl Scheme for PipeScheme

impl Scheme for ProcScheme

impl Scheme for PtyScheme

impl Scheme for RamfsScheme

impl Scheme for IpcScheme

impl Scheme for KernelScheme