Struct tectonic_engine_bibtex::BibtexEngine

pub struct BibtexEngine { /* fields omitted */ }

A struct for invoking the BibTeX engine.

This struct has a fairly straightforward “builder” interface: you create it, apply any settings that you wish, and eventually run the process() method.

Due to constraints of the gnarly C/C++ code underlying the engine implementation, only one engine may run at once in one process. The engine execution framework uses a global mutex to ensure that this is the case. This restriction applies not only to the BibtexEngine type but to all Tectonic engines. I.e., you can’t run this engine and the XeTeX engine at the same time.

Implementations

impl BibtexEngine

pub fn min_crossrefs(&mut self, value: i32) -> &mut Self

Set the BibTeX min_crossrefs parameter.

The default value is 2.

This needs verifying, but I believe that this setting affects how many times an item needs to be referenced in directly-referenced BibTeX entries before it gets its own standalone entry.

pub fn process(
    &mut self,
    launcher: &mut CoreBridgeLauncher<'_>,
    aux: &str
) -> Result<BibtexOutcome>

Run BibTeX.

The launcher parameter gives overarching environmental context in which the engine will be run.

The aux parameter gives the name of the “aux” file, created by the TeX engine, that BibTeX will process.

Trait Implementations

impl Debug for BibtexEngine

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

Formats the value using the given formatter.

impl Default for BibtexEngine

fn default() -> BibtexEngine

Returns the “default value” for a type.