Struct codespan_reporting::diagnostic::Label

pub struct Label<FileId> {
    pub style: LabelStyle,
    pub file_id: FileId,
    pub range: Range<usize>,
    pub message: String,
}

A label describing an underlined region of code associated with a diagnostic.

Fields

style: LabelStyle

The style of the label.

file_id: FileId

The file that we are labelling.

range: Range<usize>

The range in bytes we are going to include in the final snippet.

message: String

An optional message to provide some additional information for the underlined code. These should not include line breaks.

Implementations

impl<FileId> Label<FileId>

pub fn new( style: LabelStyle, file_id: FileId, range: impl Into<Range<usize>>, ) -> Label<FileId>

Create a new label.

pub fn primary(file_id: FileId, range: impl Into<Range<usize>>) -> Label<FileId>

Create a new label with a style of LabelStyle::Primary.

pub fn secondary( file_id: FileId, range: impl Into<Range<usize>>, ) -> Label<FileId>

Create a new label with a style of LabelStyle::Secondary.

pub fn with_message(self, message: impl Into<String>) -> Label<FileId>

Add a message to the diagnostic.

Trait Implementations

impl<FileId: Clone> Clone for Label<FileId>

fn clone(&self) -> Label<FileId>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<FileId: Debug> Debug for Label<FileId>

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

Formats the value using the given formatter.

impl<FileId: PartialEq> PartialEq for Label<FileId>

fn eq(&self, other: &Label<FileId>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<FileId: Eq> Eq for Label<FileId>

impl<FileId> StructuralPartialEq for Label<FileId>