Struct MockWorkspace 

pub struct MockWorkspace { /* private fields */ }

A deterministic in-memory workspace for VFS and runtime tests.

Paths accepted by this type may be relative to the workspace root or already absolute. File writes are upserts because Tinymist’s runtime-facing FileChangeSet insert side also represents both creates and updates.

Implementations

impl MockWorkspace

pub fn new(root: impl Into<PathBuf>) -> Self

Creates an empty mock workspace at the given root.

pub fn builder(root: impl Into<PathBuf>) -> MockWorkspaceBuilder

Creates a builder for a mock workspace at the given root.

pub fn default_builder() -> MockWorkspaceBuilder

Creates a builder for a mock workspace at the default test root.

pub fn root(&self) -> &Path

Returns the workspace root.

pub fn root_path(&self) -> ImmutPath

Returns the workspace root as an immutable path.

pub fn path(&self, path: impl AsRef<Path>) -> PathBuf

Resolves a test path against the workspace root.

pub fn immut_path(&self, path: impl AsRef<Path>) -> ImmutPath

Resolves a test path against the workspace root as an immutable path.

pub fn virtual_path(&self, path: impl AsRef<Path>) -> FileResult<VirtualPath>

Resolves a test path as a Typst virtual path inside the workspace.

pub fn file_id(&self, path: impl AsRef<Path>) -> FileResult<FileId>

Resolves a test path as a workspace FileId.

pub fn access_model(&self) -> MockPathAccess

Creates path access for a Tinymist VFS.

pub fn vfs(&self) -> Vfs<MockPathAccess>

Creates a VFS backed by this workspace.

pub fn read(&self, path: impl AsRef<Path>) -> FileResult<Bytes>

Reads bytes from the in-memory workspace.

pub fn contains(&self, path: impl AsRef<Path>) -> bool

Returns whether a file exists in the in-memory workspace.

pub fn write_source( &self, path: impl AsRef<Path>, source: impl Into<String>, ) -> MockChange

Creates or updates a Typst source file.

pub fn create_source( &self, path: impl AsRef<Path>, source: impl Into<String>, ) -> MockChange

Creates a Typst source file.

pub fn update_source( &self, path: impl AsRef<Path>, source: impl Into<String>, ) -> MockChange

Updates a Typst source file.

pub fn write_bytes(&self, path: impl AsRef<Path>, bytes: Bytes) -> MockChange

Creates or updates a file with arbitrary bytes.

pub fn remove(&self, path: impl AsRef<Path>) -> FileResult<MockChange>

Removes a file from the in-memory workspace.

pub fn rename( &self, from: impl AsRef<Path>, to: impl AsRef<Path>, ) -> FileResult<MockChange>

Renames a file inside the in-memory workspace.

pub fn sync_changeset(&self) -> FileChangeSet

Returns a changeset that syncs the current workspace files.

pub fn sync_filesystem_event(&self) -> FilesystemEvent

Returns a filesystem event that syncs the current workspace files.

pub fn sync_memory_event(&self) -> MemoryEvent

Returns a memory event that syncs the current workspace files.

Trait Implementations

impl Clone for MockWorkspace

fn clone(&self) -> MockWorkspace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MockWorkspace

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

Formats the value using the given formatter.

impl Default for MockWorkspace

fn default() -> Self

Returns the “default value” for a type.