Struct tectonic::io::stack::IoStack

pub struct IoStack<'a> { /* fields omitted */ }

An IoStack is an IoProvider that delegates to an ordered list of subordinate IoProviders. It also checks the order in which files are read and written to detect "circular" access patterns that indicate whether we need to run multiple passes of the TeX engine.

Implementations

impl<'a> IoStack<'a>

pub fn new(items: Vec<&'a mut dyn IoProvider>) -> IoStack<'a>

Trait Implementations

impl<'a> IoProvider for IoStack<'a>

fn output_open_name(&mut self, name: &OsStr) -> OpenResult<OutputHandle>

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

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

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_format(
    &mut self,
    name: &OsStr,
    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 for to write formats with their special munged file names.