Struct codespan_reporting::term::Chars

pub struct Chars {
    pub snippet_start: String,
    pub source_border_left: char,
    pub source_border_left_break: char,
    pub note_bullet: char,
    pub single_primary_caret: char,
    pub single_secondary_caret: char,
    pub multi_primary_caret_start: char,
    pub multi_primary_caret_end: char,
    pub multi_secondary_caret_start: char,
    pub multi_secondary_caret_end: char,
    pub multi_top_left: char,
    pub multi_top: char,
    pub multi_bottom_left: char,
    pub multi_bottom: char,
    pub multi_left: char,
    pub pointer_left: char,
}

Characters to use when rendering the diagnostic.

By using Chars::ascii() you can switch to an ASCII-only format suitable for rendering on terminals that do not support box drawing characters.

Fields

snippet_start: String

The characters to use for the top-left border of the snippet. Defaults to: "┌─" or "-->" with Chars::ascii().

source_border_left: char

The character to use for the left border of the source. Defaults to: '│' or '|' with Chars::ascii().

source_border_left_break: char

The character to use for the left border break of the source. Defaults to: '·' or '.' with Chars::ascii().

note_bullet: char

The character to use for the note bullet. Defaults to: '='.

single_primary_caret: char

The character to use for marking a single-line primary label. Defaults to: '^'.

single_secondary_caret: char

The character to use for marking a single-line secondary label. Defaults to: '-'.

multi_primary_caret_start: char

The character to use for marking the start of a multi-line primary label. Defaults to: '^'.

multi_primary_caret_end: char

The character to use for marking the end of a multi-line primary label. Defaults to: '^'.

multi_secondary_caret_start: char

The character to use for marking the start of a multi-line secondary label. Defaults to: '\''.

multi_secondary_caret_end: char

The character to use for marking the end of a multi-line secondary label. Defaults to: '\''.

multi_top_left: char

The character to use for the top-left corner of a multi-line label. Defaults to: '╭' or '/' with Chars::ascii().

multi_top: char

The character to use for the top of a multi-line label. Defaults to: '─' or '-' with Chars::ascii().

multi_bottom_left: char

The character to use for the bottom-left corner of a multi-line label. Defaults to: '╰' or '\' with Chars::ascii().

multi_bottom: char

The character to use when marking the bottom of a multi-line label. Defaults to: '─' or '-' with Chars::ascii().

multi_left: char

The character to use for the left of a multi-line label. Defaults to: '│' or '|' with Chars::ascii().

pointer_left: char

The character to use for the left of a pointer underneath a caret. Defaults to: '│' or '|' with Chars::ascii().

Implementations

impl Chars

pub fn box_drawing() -> Chars

A character set that uses Unicode box drawing characters.

pub fn ascii() -> Chars

A character set that only uses ASCII characters.

This is useful if your terminal's font does not support box drawing characters well and results in output that looks similar to rustc's diagnostic output.

Trait Implementations

impl Clone for Chars

fn clone(&self) -> Chars

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Chars

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

Formats the value using the given formatter.

impl Default for Chars

fn default() -> Chars

Returns the "default value" for a type.