Struct TarFS

pub struct TarFS { /* private fields */ }

A filesystem mounted on a Tarball archive, backed by a Memory FS. Because the FS is backed by memory, all files are immediately loaded into memory, so filtered variants of constructors should be used to avoid large files that may not need to be accessed.

Implementations

impl TarFS

pub fn new<R: Read>(archive: R) -> Result<Self>

Creates a new tar-backed filesystem.

Arguments

archive: The tarball archive itself.

pub fn new_filtered<R: Read, F: FileSystemFilter>( archive: R, filter: F, ) -> Result<Self>

Creates a new tar-backed filesystem with filtered contents.

Arguments

archive: The tarball archive itself.
filter: A filter that determines which entries are included in the filesystem.

Trait Implementations

impl FileSystem for TarFS

fn create_dir(&self, _path: &str) -> Result<()>

Creates a directory at path.

fn metadata(&self, path: &str) -> Result<Metadata>

Returns the metadata for the file/folder at `path.

fn open_file_options( &self, path: &str, options: &OpenOptions, ) -> Result<Box<dyn File>>

Opens a file at path with options options.

fn read_dir( &self, path: &str, ) -> Result<Box<dyn Iterator<Item = Result<DirEntry>>>>

Lists the files and folders contained in the directory denoted by path.

fn remove_dir(&self, _path: &str) -> Result<()>

Removes the directory at path.

fn remove_file(&self, _path: &str) -> Result<()>

Removes a file at path.

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

Creates a directory path and all of its parents.

fn create_file(&self, path: &str) -> Result<Box<dyn File>>

Creates a file at path in write mode. The file will be opened in truncate mode, so all contents will be overwritten. If this is not desirable, use open_file directly.

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

Returns Ok(true) or Ok(false) if a file or folder at path does or does not exist, and Err(_) if the presence cannot be verified.

fn open_file(&self, path: &str) -> Result<Box<dyn File>>

Opens a file at path for reading.