Struct texlang_common::InMemoryFileSystem

pub struct InMemoryFileSystem { /* private fields */ }

In-memory filesystem for use in unit tests.

This type mocks out the file system operations in the VM. It provides an in-memory system to which “files” can be added before the test runs. It is designed to help test primitives that interact with the filesystem.

Given a VM, the file system can be set as follows:

#[derive(Default)]
struct State {
    file_system: Rc<RefCell<InMemoryFileSystem>>,
}
let mut vm = vm::VM::<State>::new_with_built_in_commands(
    HashMap::new(),  // empty set of built-in commands
);
let mut mock_file_system = InMemoryFileSystem::new(&vm.working_directory.as_ref().unwrap());
mock_file_system.add_string_file("file/path.tex", "file content");
vm.state.file_system = Rc::new(RefCell::new(mock_file_system));

Implementations

impl InMemoryFileSystem

pub fn new(working_directory: &Path) -> Self

Create a new in-memory file system.

Typically the working directory is taken from the VM.

pub fn add_string_file(&mut self, relative_path: &str, content: &str)

Add a string file to the in-memory file system.

The provided path is relative to the working directory

pub fn add_bytes_file(&mut self, relative_path: &str, content: &[u8])

Add a bytes file to the in-memory file system.

The provided path is relative to the working directory

Trait Implementations

impl Default for InMemoryFileSystem

fn default() -> InMemoryFileSystem

Returns the “default value” for a type.

impl FileSystem for InMemoryFileSystem

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

Read the entire contents of a file into a string.

fn read_to_bytes(&self, path: &Path) -> Result<Vec<u8>>

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

fn write_bytes(&self, _: &Path, _: &[u8]) -> Result<()>

Write a slice of bytes to a file.