Struct source_span::fmt::Formatter

pub struct Formatter { /* fields omitted */ }

Text formatter with span highlights.

This allows you to format a given input char stream with highlights and colors (if the colors feature is enabled). A Highlight is defined by a Span, a string label and a Style, and will be rendered with the stream:

1 | fn main() {
2 |     println!("Hello World!")
  |              ^^^^^^^^^^^^^^ highlighting this string
3 | }

Highlights spans can cover multiple lines and overlap. See the Highlight documentation for more informations.

Methods

impl Formatter

#[must_use] pub fn new() -> Self

Create a new formatter with no highlights.

Note

By default line numbers are shown. You can disable them using the hide_line_numbers method.

#[must_use] pub const fn with_color(margin_color: Color) -> Self

Create a new formatter with no highlights and the specified margin color.

Note

By default line numbers are shown. You can disable them using the hide_line_numbers method.

pub fn show_line_numbers(&mut self)

Show the line numbers in the output.

This is the default.

pub fn hide_line_numbers(&mut self)

Hide the line numbers in the output.

By default, line numbers are visible.

pub fn add(&mut self, span: Span, label: Option<String>, style: Style)

Add a span highlight.

pub fn get<I: Iterator<Item = Result<char>>>(
    &self,
    input: I,
    span: Span
) -> Result<String>

Produce the formatted output.

Create a String containing the content of the input iterator given span, with the previously added highlights.

Trait Implementations

impl Default for Formatter

fn default() -> Self

Returns the "default value" for a type.