Struct tectonic::io::format_cache::FormatCache

pub struct FormatCache { /* private fields */ }

A local cache for compiled format files.

The format cache takes care of saving compiled format files. It uses the same root cache directory as the LocalCache item, but is implemented separately so that there is a way to save the format files associated with backends that may not have their own LocalCache.

Implementations

impl FormatCache

pub fn new(bundle_digest: DigestData, formats_base: PathBuf) -> FormatCache

Create a new FormatCache.

The bundle_digest should be the result of the Bundle::get_digest() call for whichever bundle is active. The formats_base path should be a local cache directory.

Trait Implementations

impl IoProvider for FormatCache

fn input_open_format( &mut self, name: &str, _status: &mut dyn StatusBackend ) -> OpenResult<InputHandle>

Open a format file with the specified name. Format files have a specialized entry point because IOProviders may wish to handle them specially: namely, to munge the filename to one that includes the current version of the Tectonic engine, since the format contents depend sensitively on the engine internals.

fn write_format( &mut self, name: &str, data: &[u8], _status: &mut dyn StatusBackend ) -> Result<()>

Save an a format dump in some way that this provider may be able to recover in the future. This awkward interface is needed to write formats with their special munged file names.

fn output_open_name(&mut self, _name: &str) -> OpenResult<OutputHandle>

Open the named file for output.

fn output_open_stdout(&mut self) -> OpenResult<OutputHandle>

Open the standard output stream.

fn input_open_name( &mut self, _name: &str, _status: &mut dyn StatusBackend ) -> OpenResult<InputHandle>

Open the named file for input.

fn input_open_name_with_abspath( &mut self, name: &str, status: &mut dyn StatusBackend ) -> OpenResult<(InputHandle, Option<PathBuf>)>

Open the named file for input and return filesystem path information.

fn input_open_primary( &mut self, _status: &mut dyn StatusBackend ) -> OpenResult<InputHandle>

Open the “primary” input file, which in the context of TeX is the main input that it’s given. When the build is being done using the filesystem and the input is a file on the filesystem, this function isn’t necesssarily that important, but those conditions don’t always hold.

fn input_open_primary_with_abspath( &mut self, status: &mut dyn StatusBackend ) -> OpenResult<(InputHandle, Option<PathBuf>)>

Open the primary input and return filesystem path information.