Struct rsfs::disk::FS

pub struct FS;

An empty struct that satisfies rsfs::FS by calling std::fs functions.

Because this is an empty struct, it is inherently thread safe and copyable. The power of using rsfs comes from the ability to choose what filesystem you want to use where: your main can use a disk backed filesystem, but your tests can use a test filesystem with injected errors.

Alternatively, the in-memory filesystem could suit your needs without forcing you to use disk.

Examples

use rsfs::*;

let fs = rsfs::disk::FS;

Trait Implementations

impl Copy for FS

impl Clone for FS

fn clone(&self) -> FS

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FS

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl GenFS for FS

type DirBuilder = DirBuilder

The DirBuilder type in the same module implementing this trait.

type DirEntry = DirEntry

The DirEntry type in the same module implementing this trait.

type File = File

The File type in the same module implementing this trait.

type Metadata = Metadata

The Metadata type in the same module implementing this trait.

type OpenOptions = OpenOptions

The OpenOptions type in the same module implementing this trait.

type Permissions = Permissions

The Permissions type in the same module implementing this trait.

type ReadDir = ReadDir

The ReadDir type in the same module implementing this trait.

fn canonicalize<P: AsRef<Path>>(&self, path: P) -> Result<PathBuf>

Returns the canonical form of a path with all intermediate components normalized and symbolic links resolved.

fn copy<P: AsRef<Path>, Q: AsRef<Path>>(&self, from: P, to: Q) -> Result<u64>

Copies the contents of one file to another. This function will also copy the permission bits of the original file to the destination file.

fn create_dir<P: AsRef<Path>>(&self, path: P) -> Result<()>

Creates a new, empty directory at the provided path.

fn create_dir_all<P: AsRef<Path>>(&self, path: P) -> Result<()>

Recursively creates a directory and all its parent components if they are missing.

fn hard_link<P: AsRef<Path>, Q: AsRef<Path>>(
    &self,
    src: P,
    dst: Q
) -> Result<()>

Creates a new hard link on the filesystem.

fn metadata<P: AsRef<Path>>(&self, path: P) -> Result<Self::Metadata>

Returns metadata information of the file or directory at path.

fn read_dir<P: AsRef<Path>>(&self, path: P) -> Result<Self::ReadDir>

Returns an iterator over entries within a directory.

fn read_link<P: AsRef<Path>>(&self, path: P) -> Result<PathBuf>

Reads a symbolic link, returning the entry the link points to.

fn remove_dir<P: AsRef<Path>>(&self, path: P) -> Result<()>

Removes an existing, empty directory.

fn remove_dir_all<P: AsRef<Path>>(&self, path: P) -> Result<()>

Removes a directory at path after removing all of its contents.

fn remove_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Removes a file from the filesystem.

fn rename<P: AsRef<Path>, Q: AsRef<Path>>(&self, from: P, to: Q) -> Result<()>

Renames a file or directory at from to to, replacing to if it exists.

fn set_permissions<P: AsRef<Path>>(
    &self,
    path: P,
    perm: Self::Permissions
) -> Result<()>

Changes the permissions of a file or directory.

fn symlink_metadata<P: AsRef<Path>>(&self, path: P) -> Result<Self::Metadata>

Query the metadata about a file without following symlinks.

fn new_openopts(&self) -> Self::OpenOptions

Returns a new OpenOptions for a file for this filesytem.

fn new_dirbuilder(&self) -> Self::DirBuilder

Returns a new DirBuilder for a directory for this filesystem.

fn open_file<P: AsRef<Path>>(&self, path: P) -> Result<Self::File>

Opens a file in read-only mode.

fn create_file<P: AsRef<Path>>(&self, path: P) -> Result<Self::File>

Opens a file in write-only mode.

impl GenFSExt for FS

fn symlink<P: AsRef<Path>, Q: AsRef<Path>>(&self, src: P, dst: Q) -> Result<()>

Creates a new symbolic link on the filesystem.