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. Identifies a file in a project or package.

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

Implementations

impl FileId

pub fn new(package: Option<PackageSpec>, path: VirtualPath) -> FileId

Create a new interned file specification.

The path must start with a / or this function will panic. Note that the path is normalized before interning.

pub fn new_fake(path: VirtualPath) -> 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.

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

The package the file resides in, if any.

pub fn vpath(&self) -> &'static VirtualPath

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

pub fn join(self, path: &str) -> FileId

Resolve a file location relative to this file.

pub fn with_extension(&self, extension: &str) -> FileId

The same file location, but with a different extension.

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.

Trait Implementations

impl Clone for FileId

fn clone(&self) -> FileId

Returns a copy 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 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 Ord for FileId

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

Restrict a value to a certain interval.

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 PartialOrd for FileId

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for FileId

impl Eq for FileId

impl StructuralPartialEq for FileId