Struct tectonic::driver::ProcessingSession
source · pub struct ProcessingSession { /* private fields */ }
Expand description
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.
Implementations§
source§impl ProcessingSession
impl ProcessingSession
sourcepub fn run(&mut self, status: &mut dyn StatusBackend) -> Result<()>
pub fn run(&mut self, status: &mut dyn StatusBackend) -> 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.
sourcepub fn get_stdout_content(&self) -> Vec<u8> ⓘ
pub fn get_stdout_content(&self) -> Vec<u8> ⓘ
Get what was printed to standard output, if anything.
sourcepub fn into_file_data(self) -> MemoryFileCollection
pub fn into_file_data(self) -> MemoryFileCollection
Consume this session and return the current set of files in memory.
This convenience function tries to help with the annoyances of getting access to the in-memory file data after the engine has been run.
Auto Trait Implementations§
impl !RefUnwindSafe for ProcessingSession
impl !Send for ProcessingSession
impl !Sync for ProcessingSession
impl Unpin for ProcessingSession
impl !UnwindSafe for ProcessingSession
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more