Struct typst_syntax::VirtualPath

pub struct VirtualPath(/* private fields */);

An absolute path in the virtual file system of a project or package.

Implementations

impl VirtualPath

pub fn new(path: impl AsRef<Path>) -> Self

Create a new virtual path.

Even if it doesn’t start with / or \, it is still interpreted as starting from the root.

pub fn within_root(path: &Path, root: &Path) -> Option<Self>

Create a virtual path from a real path and a real root.

Returns None if the file path is not contained in the root (i.e. if root is not a lexical prefix of path). No file system operations are performed.

pub fn as_rooted_path(&self) -> &Path

Get the underlying path with a leading / or \.

pub fn as_rootless_path(&self) -> &Path

Get the underlying path without a leading / or \.

pub fn resolve(&self, root: &Path) -> Option<PathBuf>

Resolve the virtual path relative to an actual file system root (where the project or package resides).

Returns None if the path lexically escapes the root. The path might still escape through symlinks.

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

Resolve a path relative to this virtual path.

Trait Implementations

impl Clone for VirtualPath

fn clone(&self) -> VirtualPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualPath

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

Formats the value using the given formatter.

impl Hash for VirtualPath

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 Ord for VirtualPath

fn cmp(&self, other: &VirtualPath) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for VirtualPath

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for VirtualPath

fn partial_cmp(&self, other: &VirtualPath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for VirtualPath

impl StructuralPartialEq for VirtualPath