Struct PlainStatusBackend

pub struct PlainStatusBackend { /* private fields */ }

A basic status-reporting backend that prints messages via stdio.

Implementations

impl PlainStatusBackend

pub fn new(chatter: ChatterLevel) -> Self

Create a new backend with the specified chatter level.

To use the default chatter level, you can also use Self::default.

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

Configure this backend to always print to the standard error stream.

This setting can be useful if you have a program that is printing output to standard output that needs to be machine-parsable. By activating it you can ensure that any status reports don’t get mixed in with your stdout output.

Trait Implementations

impl Clone for PlainStatusBackend

fn clone(&self) -> PlainStatusBackend

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlainStatusBackend

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

Formats the value using the given formatter.

impl Default for PlainStatusBackend

fn default() -> PlainStatusBackend

Returns the “default value” for a type.

impl StatusBackend for PlainStatusBackend

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

Report a message to the status backend.

fn report_error(&mut self, err: &Error)

Report an error to the status backend.

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

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

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

This is used to print TeX engine logs after it encountered errors. This should print the provided output, which may span many lines, with some clear delineation.