Struct annotate_snippets::formatter::DisplayListFormatter

pub struct DisplayListFormatter { /* fields omitted */ }

DisplayListFormatter' constructor accepts two arguments:

• color allows the formatter to optionally apply colors and emphasis using the ansi_term crate.
• anonymized_line_numbers will replace line numbers in the left column with the text LL.

Example:

use annotate_snippets::formatter::DisplayListFormatter;
use annotate_snippets::display_list::{DisplayList, DisplayLine, DisplaySourceLine};

let dlf = DisplayListFormatter::new(false, false); // Don't use colors, Don't anonymize line numbers

let dl = DisplayList {
    body: vec![
        DisplayLine::Source {
            lineno: Some(192),
            inline_marks: vec![],
            line: DisplaySourceLine::Content {
                text: "Example line of text".into(),
                range: (0, 21)
            }
        }
    ]
};
assert_eq!(dlf.format(&dl), "192 | Example line of text");

Methods

impl DisplayListFormatter

pub fn new(color: bool, anonymized_line_numbers: bool) -> Self

Constructor for the struct.

The argument color selects the stylesheet depending on the user preferences and ansi_term crate availability.

The argument anonymized_line_numbers will replace line numbers in the left column with the text LL. This can be useful to enable when running UI tests, such as in the Rust test suite.

pub fn format(&self, dl: &DisplayList) -> String

Formats a DisplayList into a String.