Trait tectonic::status::StatusBackend

pub trait StatusBackend {
    fn report(
        &mut self, 
        kind: MessageKind, 
        args: Arguments<'_>, 
        err: Option<&Error>
    );
    fn dump_error_logs(&mut self, output: &[u8]);

    fn note_highlighted(&mut self, before: &str, highlighted: &str, after: &str) { ... }
}

Required methods

fn report(
    &mut self,
    kind: MessageKind,
    args: Arguments<'_>,
    err: Option<&Error>
)

Report a message to the status backend.

fn dump_error_logs(&mut self, output: &[u8])

This is used to print TeX engine logs after it encountered errors. This prints the log, surrounded by lines of equal signs.

Loading content...

Provided methods

fn note_highlighted(&mut self, before: &str, highlighted: &str, after: &str)

Issue a note-level status, idealy highlighting a particular phrase.

This is a bit of a hack. For [driver::ProcessingSession::run], I like the UX when we issue notes in this style. It's a bit more high-level than intended for this trait, but we can provide a nice sensible default implementation, so whatever.

Loading content...

Implementors

impl StatusBackend for PlainStatusBackend

fn report(
    &mut self,
    kind: MessageKind,
    args: Arguments<'_>,
    err: Option<&Error>
)

fn note_highlighted(&mut self, before: &str, highlighted: &str, after: &str)

fn dump_error_logs(&mut self, output: &[u8])

impl StatusBackend for NoopStatusBackend

fn report(
    &mut self,
    _kind: MessageKind,
    _args: Arguments<'_>,
    _err: Option<&Error>
)

fn dump_error_logs(&mut self, _output: &[u8])

impl StatusBackend for TermcolorStatusBackend

fn report(
    &mut self,
    kind: MessageKind,
    args: Arguments<'_>,
    err: Option<&Error>
)

fn note_highlighted(&mut self, before: &str, highlighted: &str, after: &str)

fn dump_error_logs(&mut self, output: &[u8])

Loading content...