Struct tectonic_bundles::cache::CachingBundle

pub struct CachingBundle<CB: CacheBackend> { /* private fields */ }

A caching bundle that obtains files from some a backend.

This bundle implementation is the key to Tectonic’s ability to download TeX support files on the fly. The cache backend is generally expected to be some kind of network-based resource, and the caching scheme is designed so that a document build can avoid touching the network altogether if no new files need to be downloaded.

Trait Implementations

impl<CB: CacheBackend> Bundle for CachingBundle<CB>

fn get_digest(&mut self, _status: &mut dyn StatusBackend) -> Result<DigestData>

Get a cryptographic digest summarizing this bundle’s contents.

fn all_files(&mut self, status: &mut dyn StatusBackend) -> Result<Vec<String>>

Enumerate the files in this bundle.

impl<CB: Debug + CacheBackend> Debug for CachingBundle<CB>where CB::FileInfo: Debug,

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

Formats the value using the given formatter.

impl<CB: CacheBackend> IoProvider for CachingBundle<CB>

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

Open the named file for input.

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_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.

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<(), Error>

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.