Struct TypstFileId 

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

Although this is not good to expose this, we make an alias here to let it as a part of typst-ts. An interned version of [RootedPath].

This type is globally interned and thus cheap to copy, compare, and hash.

Implementations

impl FileId

pub fn new(path: RootedPath) -> FileId

Create a new interned file specification.

This is the same as [RootedPath::intern].

pub fn unique(path: RootedPath) -> FileId

Create a new unique (“fake”) file specification, which is not accessible by path.

Caution: the ID returned by this method is the only identifier of the file, constructing a file ID with a path will not reuse the ID even if the path is the same. This method should only be used for generating “virtual” file ids such as content read from stdin.

While the returned ID is not otherwise accessible, the provided root and path still matter as they define how paths within the identified file will resolve. For the example of content read from stdin, it will define how a relative path in the stdin content is resolved.

pub const fn from_raw(v: NonZero<u16>) -> FileId

Construct from a raw number.

Should only be used with numbers retrieved via into_raw. Misuse may results in panics, but no unsafety.

pub const fn into_raw(self) -> NonZero<u16>

Extract the raw underlying number.

pub fn get(&self) -> &'static RootedPath

Get the static, interned rooted path.

Methods from Deref<Target = RootedPath>

pub fn root(&self) -> &VirtualRoot

The root this path resides in.

pub fn package(&self) -> Option<&PackageSpec>

👎Deprecated: use root instead

The package the path resides in, if any.

pub fn vpath(&self) -> &VirtualPath

The absolute and normalized path to the file within the project or package.

pub fn map(&self, f: impl FnOnce(&VirtualPath) -> VirtualPath) -> RootedPath

Maps the virtual path while retaining the root.

Trait Implementations

impl Clone for FileId

fn clone(&self) -> FileId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileId

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

Formats the value using the given formatter.

impl Deref for FileId

type Target = RootedPath

The resulting type after dereferencing.

fn deref(&self) -> &<FileId as Deref>::Target

Dereferences the value.

impl Hash for FileId

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

where __H: Hasher,

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 FileId

fn eq(&self, other: &FileId) -> 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 Copy for FileId

impl Eq for FileId

impl StructuralPartialEq for FileId