Struct GeneratedLayoutCapture 

pub struct GeneratedLayoutCapture {
    pub page_builds: usize,
    pub shipouts: usize,
    pub special_outputs: usize,
    pub picture_loads: usize,
    pub source_specials: usize,
    pub write_whatsit_diagnostics: usize,
    pub pdf_extensions: usize,
    pub transcript_bytes: usize,
    pub page_top_prunes: usize,
    pub last_shipout_box: Option<GeneratedNodeHandle>,
    pub captured_fragment_root: Option<GeneratedNodeHandle>,
    pub last_abort_status: Option<i32>,
}

Layout capture from stripped generated engine output.

Fields

page_builds: usize

Number of times a page was built and sent to output.

shipouts: usize

Number of completed shipout calls.

special_outputs: usize

Number of \special outputs recorded.

picture_loads: usize

Number of picture file loads.

source_specials: usize

Number of source special whatsits emitted.

write_whatsit_diagnostics: usize

Number of \write whatsit diagnostics recorded.

pdf_extensions: usize

Number of pdf extension calls recorded.

transcript_bytes: usize

Total bytes written to the engine transcript.

page_top_prunes: usize

Number of times the page top was pruned.

last_shipout_box: Option<GeneratedNodeHandle>

Node handle of the most recent shipped out box, if any.

captured_fragment_root: Option<GeneratedNodeHandle>

Node handle of the captured fragment root, if any.

last_abort_status: Option<i32>

Final abort status code from the engine, if it aborted.

Implementations

impl GeneratedLayoutCapture

pub fn from_engine(engine: &PortableTexEngine<'_>) -> Self

Reads capture statistics directly from a running engine.

pub fn last_shipout_snapshot( &self, engine: &PortableTexEngine<'_>, ) -> Option<GeneratedNodeSnapshot>

Snapshots the last shipped out box, or None if none was shipped.

pub fn to_fragment( &self, engine: &PortableTexEngine<'_>, metadata: FragmentMetadata, ) -> Option<Fragment>

Converts the captured output to an IR Fragment.

pub fn to_fragment_with_source( &self, engine: &PortableTexEngine<'_>, metadata: FragmentMetadata, _source_name: impl Into<String>, _source_span: ByteSpan, ) -> Option<Fragment>

Source provenance parameters are unused because this path does not thread source spans yet.

pub fn to_fragment_with_recorded_source( &self, engine: &PortableTexEngine<'_>, metadata: FragmentMetadata, ) -> Option<Fragment>

Converts captured output to an IR Fragment using source spans recorded in the engine.

Trait Implementations

impl Clone for GeneratedLayoutCapture

fn clone(&self) -> GeneratedLayoutCapture

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for GeneratedLayoutCapture

impl Debug for GeneratedLayoutCapture

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

Formats the value using the given formatter.

impl Default for GeneratedLayoutCapture

fn default() -> GeneratedLayoutCapture

Returns the “default value” for a type.

impl Eq for GeneratedLayoutCapture

impl PartialEq for GeneratedLayoutCapture

fn eq(&self, other: &GeneratedLayoutCapture) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GeneratedLayoutCapture