Trait FileSystem

pub trait FileSystem {
    type Path: ?Sized;
    type PathBuf: AsRef<Self::Path>;
    type Error: Error;

    // Required methods
    fn open(
        &mut self,
        path: &Self::Path,
        output: bool,
    ) -> Result<FileDescriptor, Self::Error>;
    fn close(&mut self, descriptor: FileDescriptor) -> Result<(), Self::Error>;
    fn read(
        &mut self,
        descriptor: FileDescriptor,
    ) -> Result<Option<u8>, Self::Error>;
    fn write(
        &mut self,
        descriptor: FileDescriptor,
        byte: u8,
    ) -> Result<(), Self::Error>;
    fn flush(&mut self, descriptor: FileDescriptor) -> Result<(), Self::Error>;
    fn delete(&mut self, path: &Self::Path) -> Result<(), Self::Error>;
    fn exists(&self, path: &Self::Path) -> Result<bool, Self::Error>;
    fn decode_path(
        memory: &Memory<'_>,
        list: Value,
    ) -> Result<Self::PathBuf, Self::Error>;
}

A file system.

Required Associated Types

type Path: ?Sized

A path.

type PathBuf: AsRef<Self::Path>

A path buffer.

type Error: Error

An error.

Required Methods

fn open( &mut self, path: &Self::Path, output: bool, ) -> Result<FileDescriptor, Self::Error>

Opens a file and returns its descriptor.

fn close(&mut self, descriptor: FileDescriptor) -> Result<(), Self::Error>

Closes a file.

fn read( &mut self, descriptor: FileDescriptor, ) -> Result<Option<u8>, Self::Error>

Reads a file.

fn write( &mut self, descriptor: FileDescriptor, byte: u8, ) -> Result<(), Self::Error>

Writes a file.

fn flush(&mut self, descriptor: FileDescriptor) -> Result<(), Self::Error>

Flushes a file.

fn delete(&mut self, path: &Self::Path) -> Result<(), Self::Error>

Deletes a file.

fn exists(&self, path: &Self::Path) -> Result<bool, Self::Error>

Checks if a file exists.

fn decode_path( memory: &Memory<'_>, list: Value, ) -> Result<Self::PathBuf, Self::Error>

Decodes a path.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl FileSystem for MemoryFileSystem<'_>

type Path = [u8]

type PathBuf = Vec<u8, PATH_SIZE>

type Error = FileError

impl FileSystem for VoidFileSystem

type Path = [u8]

type PathBuf = [u8; 0]

type Error = FileError