Struct tectonic::driver::ProcessingSession

pub struct ProcessingSession {
    pub io: IoSetup,
    pub events: IoEvents,
    // some fields omitted
}

The ProcessingSession struct runs the whole show when we're actually processing a file. It understands, for example, the need to re-run the TeX engine if the .aux file changed.

Fields

io: IoSetup

This contains the full I/O setup of the processing session. After running the session, you can inspect this to see what I/O was produced. (For example, the memory layer might contain some files that were produced by the TeX engine but not actually written to disk.)

events: IoEvents

This contains all the I/O events that occurred while processing.

Methods

impl ProcessingSession

pub fn run(&mut self, status: &mut TermcolorStatusBackend) -> Result<()>

Runs the session, generating the desired outputs.

What this does depends on which PassSetting you asked for. The most common choice is PassSetting::Default, in which case this method does the following:

• if a .fmt file does not yet exist, generate one and cache it
• run the TeX engine once
• run BibTeX, if it seems to be required
• repeat the last two steps as often as needed
• write the output files to disk, including a Makefile if it was requested.