Enum source_span::fmt::Style

pub enum Style {
    Error,
    Warning,
    Note,
    Custom(char, char, Color),
}

Highlight format description.

Specifies how the highlight should be rendered:

• What character to use to draw the line under one-lined highlights.

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

In this example, the line character is +.

• What boundary marker character to use to point the first and last elements of a multi-line highlight.

1 |   fn main() {
  |  ___________^
2 | |     println!("Hello World!")
3 | | }
  | |_^ this span covers more than one line

In this example, the boundary marker is ^. The line character is not used.

Colors

If the colors feature is enabled, it is also possible to set a color to draw the lines. This will also make the highlights more bright (or bold), along with the line numbers.

Variants

Error

Red curvy underline.

Warning

Yellow curvy underline.

Note

Blue straight underline.

Custom(char, char, Color)

Custom highlight format.

Specifies the line character, the boundary marker and the color (if the colors feature is enabled) used to render the highlight.

Methods

impl Style

#[must_use] pub const fn new(line: char, marker: char, color: Color) -> Self

Create a new custom highlight style.

The line character is user to draw the line under the span elements. The marker character is used to point to the first and last elements of the span when relevant.

#[must_use] pub fn line(&self) -> char

The character used to draw the line under the span elements.

#[must_use] pub fn marker(&self) -> char

The character used to point the first and last element of the span when relevant.

#[must_use] pub fn color(&self) -> Color

Get the color used to draw the highlight.

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Style