Struct tectonic::io::setup::IoSetupBuilder

pub struct IoSetupBuilder { /* fields omitted */ }

The IoSetupBuilder provides a convenient builder interface for specifying the I/O setup.

Implementations

impl IoSetupBuilder

pub fn primary_input_path<P: AsRef<Path>>(&mut self, path: P) -> &mut Self

Sets the path for the primary input (i.e. the main .tex file).

If other functions that set the primary input mode are called (e.g. IoSetupBuilder::primary_input_stdin, the setting will be overridden.

pub fn primary_input_stdin(&mut self) -> &mut Self

Configures us to read the primary input (i.e. the main .tex file) from stdin.

If other functions that set the primary input mode are called (e.g. IoSetupBuilder::primary_input_path, the setting will be overridden.

pub fn primary_input_buffer(&mut self, buf: Vec<u8>) -> &mut Self

Configures us to read the primary input (i.e. the main .tex file) from an in-memory buffer.

If other functions that set the primary input mode are called (e.g. IoSetupBuilder::primary_input_path, the setting will be overridden.

pub fn filesystem_root<P: AsRef<Path>>(&mut self, path: P) -> &mut Self

Sets the path for the filesystem root.

This should probably not actually be the root of the entire filesystem; rather, it is a path where the TeX engine will look for included files.

pub fn format_cache_path<P: AsRef<Path>>(&mut self, path: P) -> &mut Self

Sets the path for the format cache.

The IoSetup created from this object will cache format files if the primary bundle has been specified (by calling self.bundle()). This call sets the filesystem path where format files are cached. If left unset, it defaults to the filesystem root, which is probably not what you want.

pub fn bundle<T: 'static + Bundle>(&mut self, bundle: T) -> &mut Self

Adds a bundle to the I/O configuration.

pub fn use_genuine_stdout(&mut self, setting: bool) -> &mut Self

Determines whether to use stdout.

If this is set to false, I/O that was destined to stdout is instead redirected to the memory I/O layer (where it can be examined using the mem field on IoSetup).

pub fn hide_path<P: AsRef<Path>>(&mut self, path: P) -> &mut Self

Marks a path as hidden, meaning that the filesystem layer will pretend it doesn't exist.

pub fn create(self, status: &mut dyn StatusBackend) -> Result<IoSetup>

Creates an IoSetup.

Panics

Panics if no primary input mechanism was specified.

Trait Implementations

impl Default for IoSetupBuilder

fn default() -> Self

Returns the "default value" for a type.