Skip to main content

Module driver

Module driver 

Source
Expand description

The high-level Tectonic document processing interface.

The main struct in this module is ProcessingSession, which knows how to run (and re-run if necessary) the various engines in the right order. Such a session can be created with a ProcessingSessionBuilder, which you might obtain from a tectonic_docmodel::document::Document using the crate::docmodel::DocumentExt::setup_session extension method, if you’re using the Tectonic document model. You can set one up manually if not.

For an example of how to use this module, see src/bin/tectonic/main.rs, which contains tectonic’s main CLI program.

Structs§

ProcessingSession
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.
ProcessingSessionBuilder
A builder-style interface for creating a ProcessingSession.

Enums§

OutputFormat
The different types of output files that tectonic knows how to produce.
PassSetting
The different types of “passes” that ProcessingSession knows how to run. See ProcessingSession::run for more details.