Struct Paths

pub struct Paths { /* private fields */ }

An object which contains various paths relevant for handling on-disk operations and path transformations.

The paths retruned by this struct are not guaranteed to exist on disk, but if they don’t exist at the given paths, then they don’t exist for a project.

Implementations

impl Paths

pub fn new<P, Q>(project: P, vcs: Q) -> Self

where P: Into<PathBuf>, Q: Into<Option<PathBuf>>,

Create a new project with the given roots.

It is recommended to canonicalize them, but it is not strictly necessary.

impl Paths

pub fn project_root(&self) -> &Path

Returns the path to the project root.

The project root is used to resolve absolute paths in typst when executing tests.

pub fn manifest(&self) -> PathBuf

Returns the path to the project manifest (typst.toml).

pub fn test_root(&self) -> PathBuf

Returns the path to the test root. That is the path within the project root where the regression test suite is located.

The test root is used to resolve test identifiers.

pub fn template(&self) -> PathBuf

Returns the path to the test template, that is, the source template to use when generating new tests, not a template test.

pub fn vcs_root(&self) -> Option<&Path>

Returns the absolute canonicalized path to the vcs root. That is the path within which the project may be located.

The vcs root is used for properly handling non-persistent storage of tests.

pub fn test_dir(&self, id: &Id) -> PathBuf

Create a path to the test directory for the given identifier.

pub fn test_script(&self, id: &Id) -> PathBuf

Create a path to the test script for the given identifier.

pub fn test_ref_script(&self, id: &Id) -> PathBuf

Create a path to the reference script for the given identifier.

pub fn test_ref_dir(&self, id: &Id) -> PathBuf

Create a path to the reference directory for the given identifier.

pub fn test_out_dir(&self, id: &Id) -> PathBuf

Create a path to the output directory for the given identifier.

pub fn test_diff_dir(&self, id: &Id) -> PathBuf

Create a path to the difference directory for the given identifier.

Trait Implementations

impl Clone for Paths

fn clone(&self) -> Paths

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Paths

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

Formats the value using the given formatter.

impl Hash for Paths

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Paths

fn eq(&self, other: &Paths) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Paths

impl StructuralPartialEq for Paths