Struct BundleCache 

pub struct BundleCache<'this, T> { /* private fields */ }

A cache wrapper for another bundle.

This bundle implementation is the key to Tectonic’s ability to download TeX support files on the fly. This is usually used to wrap some kind of network- based bundle, but can be used with any struct that implements Bundle.

The caching scheme here is designed so that a document build may avoid touching the network altogether if no new files need to be downloaded.

Implementations

impl<'this, T: FileIndex<'this>> BundleCache<'this, T>

pub fn new( bundle: Box<dyn CachableBundle<'this, T>>, only_cached: bool, cache_root: Option<PathBuf>, ) -> Result<Self>

Make a new filesystem-backed cache from bundle.

This method will fail if we can’t connect to the bundle AND we don’t already have it in our cache. Other than that, this method does not require network access.

Trait Implementations

impl<'this, T: FileIndex<'this>> Bundle for BundleCache<'this, T>

fn get_digest(&mut self) -> Result<DigestData>

Get a cryptographic digest summarizing this bundle’s contents, which summarizes the exact contents of every file in the bundle.

fn all_files(&self) -> Vec<String>

Iterate over all file paths in this bundle. This is used for the bundle search command

impl<'this, T: FileIndex<'this>> IoProvider for BundleCache<'this, T>

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.