Struct tectonic::engines::tex::TexEngine

pub struct TexEngine { /* fields omitted */ }

Implementations

impl TexEngine

pub fn new() -> TexEngine

pub fn halt_on_error_mode(&mut self, halt_on_error: bool) -> &mut Self

pub fn initex_mode(&mut self, initex: bool) -> &mut Self

Configure the engine to run in "initex" mode, in which it generates a "format" file that serializes the engine state rather than a PDF document.

pub fn synctex(&mut self, synctex_enabled: bool) -> &mut Self

Configure the engine to produce SyncTeX data.

pub fn semantic_pagination(&mut self, enabled: bool) -> &mut Self

Configure the engine to use “semantic pagination”.

In this mode, the TeX page builder is not run, and top-level boxes are output vertically as they are created. The output file format changes from XDV to SPX (which is admittedly quite similar). "Page breaks" can be inserted explicitly in the document, but they only have semantic (organizational) meaning, rather than affecting the document rendering.

This is an essential component of the HTML output process.

pub fn build_date(&mut self, date: SystemTime) -> &mut Self

Sets the date and time used by the TeX engine. This affects things like LaTeX's \today command. When expecting reproducible builds, this should be set to a static value, like its default value UNIX_EPOCH.

pub fn process(
    &mut self,
    io: &mut IoStack<'_>,
    events: &mut dyn IoEventBackend,
    status: &mut dyn StatusBackend,
    format_file_name: &str,
    input_file_name: &str
) -> Result<TexResult>

Trait Implementations

impl Debug for TexEngine

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

Formats the value using the given formatter.

impl Default for TexEngine

fn default() -> Self

Returns the "default value" for a type.