Struct FsRoot 

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

A root that is backed by a file system directory.

A Typst project forms a root. Similarly, each package has its own root. Through this mechanism, projects and packages are isolated from each other.

Implementations

impl FsRoot

pub fn new(root: PathBuf) -> Self

Creates a new instance with the given root path.

pub fn path(&self) -> &Path

The path at which the root resides in the file system.

pub fn resolve(&self, path: &VirtualPath) -> PathBuf

Resolves the real file system path for the given virtual path in this root.

pub fn load(&self, path: &VirtualPath) -> FileResult<Bytes>

Loads file data from the given virtual path in this root.

Trait Implementations

impl Clone for FsRoot

fn clone(&self) -> FsRoot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FsRoot

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

Formats the value using the given formatter.

impl Eq for FsRoot

impl Hash for FsRoot

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 FsRoot

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