Struct io_providers::TempFs

pub struct TempFs { /* fields omitted */ }

Provides access to file I/O in a chroot-like temporary filesystem, located in the system's default temp directory. This temporary directory acts like the root of the filesystem: all absolute paths are relative to it, and any path which would traverse out of it is considered invalid.

This is NOT intended to act as a secure sandbox; while it ought to handle edge cases such as path traversals and symbolic links correctly, no attempt has been made to verify that there is no way to circumvent this.

Methods

impl TempFs

pub fn new() -> Result<TempFs>

Creates a new TempFs.

pub fn path(&self) -> &Path

Returns the path to the root of this temporary filesystem.

Trait Implementations

impl Debug for TempFs

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

Formats the value using the given formatter.

impl Fs for TempFs

fn open<P: AsRef<Path>>(     &mut self,     path: P,     open_options: &OpenOptions ) -> Result<File>

Opens a file at path with the options specified by open_options.

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

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

fn copy<P: AsRef<Path>, Q: AsRef<Path>>(     &mut 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>>(&mut self, path: P) -> Result<()>

Creates a new, empty directory at the provided path.

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

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

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

Creates a new hard link on the filesystem.

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

Given a path, query the file system to get information about a file, directory, etc.

fn read<P: AsRef<Path>>(&self, path: P) -> Result<Vec<u8>>

Read the entire contents of a file into a bytes vector.

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

Returns an iterator over the entries within a directory.

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

Reads a symbolic link, returning the file that the link points to.

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

Read the entire contents of a file into a string.

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

Removes an existing, empty directory.

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

Removes a directory at this path, after removing all its contents. Use carefully!

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

Removes a file from the filesystem.

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

Rename a file or directory to a new name, replacing the original file if to already exists.

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

Changes the permissions found on a file or a directory.

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

Query the metadata about a file without following symlinks.

fn write<P: AsRef<Path>, C: AsRef<[u8]>>(     &mut self,     path: P,     contents: C ) -> Result<()>

Write a slice as the entire contents of a file.

fn exists<P: AsRef<Path>>(&self, path: P) -> bool

Returns whether the path points at an existing entity.