Trait ProvideFile 

pub trait ProvideFile: Send + Sync {
    // Required methods
    fn provide_source(
        &self,
        id: FileId,
        progress: &mut dyn Progress,
    ) -> FileResult<Source>;
    fn provide_bytes(
        &self,
        id: FileId,
        progress: &mut dyn Progress,
    ) -> FileResult<Bytes>;
    fn reset_all(&self);
}

A trait for providing access to files.

Required Methods

fn provide_source( &self, id: FileId, progress: &mut dyn Progress, ) -> FileResult<Source>

Provides a Typst source with the given file id.

This may download a package, for which the progress callbacks will be used.

fn provide_bytes( &self, id: FileId, progress: &mut dyn Progress, ) -> FileResult<Bytes>

Provides a generic file with the given file id.

This may download a package, for which the progress callbacks will be used.

fn reset_all(&self)

Reset the cached files for the next compilation.

Implementations on Foreign Types

impl<W: ProvideFile> ProvideFile for &W

fn provide_source( &self, id: FileId, progress: &mut dyn Progress, ) -> FileResult<Source>

fn provide_bytes( &self, id: FileId, progress: &mut dyn Progress, ) -> FileResult<Bytes>

fn reset_all(&self)

impl<W: ProvideFile> ProvideFile for Box<W>

fn provide_source( &self, id: FileId, progress: &mut dyn Progress, ) -> FileResult<Source>

fn provide_bytes( &self, id: FileId, progress: &mut dyn Progress, ) -> FileResult<Bytes>

fn reset_all(&self)

impl<W: ProvideFile> ProvideFile for Arc<W>

fn provide_source( &self, id: FileId, progress: &mut dyn Progress, ) -> FileResult<Source>

fn provide_bytes( &self, id: FileId, progress: &mut dyn Progress, ) -> FileResult<Bytes>

fn reset_all(&self)

Implementors

impl ProvideFile for FilesystemFileProvider

impl ProvideFile for VirtualFileProvider