Struct TestSystem 

pub struct TestSystem { /* private fields */ }

System implementation intended for testing.

It uses a memory-file system by default, but can be switched to the real file system for tests verifying more advanced file system features.

Warning

Don’t use this system for production code. It’s intended for testing only.

Implementations

impl TestSystem

pub fn new( inner: impl WritableSystem + RefUnwindSafe + Send + Sync + 'static, ) -> Self

pub fn set_env_var(&self, name: impl Into<String>, value: impl Into<String>)

Sets an environment variable override. This takes precedence over the inner system.

pub fn remove_env_var(&self, name: impl Into<String>)

Removes an environment variable override, making it appear as not set.

pub fn in_memory(&self) -> &InMemorySystem

Returns the InMemorySystem.

Panics

If the underlying test system isn’t the InMemorySystem.

pub fn memory_file_system(&self) -> &MemoryFileSystem

Returns the memory file system.

Panics

If the underlying test system isn’t the InMemorySystem.

Trait Implementations

impl Clone for TestSystem

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TestSystem

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

Formats the value using the given formatter.

impl Default for TestSystem

fn default() -> Self

Returns the “default value” for a type.

impl System for TestSystem

fn path_metadata(&self, path: &SystemPath) -> Result<Metadata>

Reads the metadata of the file or directory at path.

fn canonicalize_path(&self, path: &SystemPath) -> Result<SystemPathBuf>

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

fn is_same_file(&self, first: &SystemPath, second: &SystemPath) -> Result<bool>

Returns true if both paths refer to the same file.

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

Reads the content of the file at path into a String.

fn read_to_notebook(&self, path: &SystemPath) -> Result<Notebook, NotebookError>

Reads the content of the file at path as a Notebook.

fn read_virtual_path_to_string( &self, path: &SystemVirtualPath, ) -> Result<String>

Reads the content of the virtual file at path into a String.

fn read_virtual_path_to_notebook( &self, path: &SystemVirtualPath, ) -> Result<Notebook, NotebookError>

Reads the content of the virtual file at path as a Notebook.

fn current_directory(&self) -> &SystemPath

Returns the current working directory

fn user_config_directory(&self) -> Option<SystemPathBuf>

Returns the directory path where user configurations are stored.

fn cache_dir(&self) -> Option<SystemPathBuf>

Returns the directory path where cached files are stored.

fn which(&self, _name: &str) -> WhichResult

Find an executable binary’s path by name.

fn command_executor(&self) -> Option<&dyn CommandExecutor>

Returns the system’s command executor, if it supports running commands.

fn read_directory<'a>( &'a self, path: &SystemPath, ) -> Result<Box<dyn Iterator<Item = Result<DirectoryEntry>> + 'a>>

Iterate over the contents of the directory at path.

fn walk_directory(&self, path: &SystemPath) -> WalkDirectoryBuilder

Recursively walks the content of path.

fn as_writable(&self) -> Option<&dyn WritableSystem>

Returns a handle to a WritableSystem if this system is writable.

fn as_any(&self) -> &dyn Any

fn as_any_mut(&mut self) -> &mut dyn Any

fn env_var(&self, name: &str) -> Result<String, VarError>

Fetches the environment variable key from the current process.

fn dyn_clone(&self) -> Box<dyn System>

fn source_type(&self, path: &SystemPath) -> Option<PySourceType>

Returns the source type for path if known or None.

fn virtual_path_source_type( &self, path: &SystemVirtualPath, ) -> Option<PySourceType>

Returns the source type for path if known or None.

fn run_command(&self, command: Command) -> Result<Output>

Runs command and captures its standard output and standard error.

fn path_exists(&self, path: &SystemPath) -> bool

Returns true if path exists.

fn is_directory(&self, path: &SystemPath) -> bool

Returns true if path exists and is a directory.

fn is_file(&self, path: &SystemPath) -> bool

Returns true if path exists and is a file.

impl WritableSystem for TestSystem

fn create_new_file(&self, path: &SystemPath) -> Result<()>

Creates a file at the given path.

fn write_file_bytes(&self, path: &SystemPath, content: &[u8]) -> Result<()>

Writes the given content to the file at the given path.

fn create_directory_all(&self, path: &SystemPath) -> Result<()>

Creates a directory at path as well as any intermediate directories.

fn dyn_clone(&self) -> Box<dyn WritableSystem>

fn write_file(&self, path: &SystemPath, content: &str) -> Result<()>

Writes the given content to the file at the given path.

fn get_or_cache( &self, path: &SystemPath, read_contents: &dyn Fn() -> Result<String>, ) -> Result<Option<SystemPathBuf>>

Reads the provided file from the system cache, or creates the file if necessary.