Enum annotate_snippets::display_list::DisplayHeaderType

pub enum DisplayHeaderType {
    Initial,
    Continuation,
}

Information whether the header is the initial one or a consequitive one for multi-slice cases.

Variants

Initial

Initial header is the first header in the snippet.

Example:

use annotate_snippets::display_list::*;
use annotate_snippets::formatter::DisplayListFormatter;

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

let dl = DisplayList {
    body: vec![
        DisplayLine::Raw(DisplayRawLine::Origin {
            path: "file1.rs".to_string(),
            pos: Some((51, 5)),
            header_type: DisplayHeaderType::Initial,
        })
    ]
};
assert_eq!(dlf.format(&dl), "--> file1.rs:51:5");

Continuation

Continuation marks all headers of following slices in the snippet.

Example:

use annotate_snippets::display_list::*;
use annotate_snippets::formatter::DisplayListFormatter;

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

let dl = DisplayList {
    body: vec![
        DisplayLine::Raw(DisplayRawLine::Origin {
            path: "file1.rs".to_string(),
            pos: Some((51, 5)),
            header_type: DisplayHeaderType::Continuation,
        })
    ]
};
assert_eq!(dlf.format(&dl), "::: file1.rs:51:5");

Trait Implementations

impl Clone for DisplayHeaderType

fn clone(&self) -> DisplayHeaderType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DisplayHeaderType

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

Formats the value using the given formatter.

impl PartialEq<DisplayHeaderType> for DisplayHeaderType

fn eq(&self, other: &DisplayHeaderType) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DisplayHeaderType