[−][src]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>[src][−]

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

Create a new label.

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

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

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

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

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

Add a message to the diagnostic.

Trait Implementations

impl<FileId: Clone> Clone for Label<FileId>[src][+]

impl<FileId: Debug> Debug for Label<FileId>[src][+]

impl<FileId: Eq> Eq for Label<FileId>[src]

impl<FileId: PartialEq> PartialEq<Label<FileId>> for Label<FileId>[src][+]

impl<FileId> StructuralEq for Label<FileId>[src]

impl<FileId> StructuralPartialEq for Label<FileId>[src]

Auto Trait Implementations

impl<FileId> RefUnwindSafe for Label<FileId> where
    FileId: RefUnwindSafe, 

impl<FileId> Send for Label<FileId> where
    FileId: Send, 

impl<FileId> Sync for Label<FileId> where
    FileId: Sync, 

impl<FileId> Unpin for Label<FileId> where
    FileId: Unpin, 

impl<FileId> UnwindSafe for Label<FileId> where
    FileId: UnwindSafe, 

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src][+]

impl<T> Borrow<T> for T where
    T: ?Sized, [src][+]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src][+]

impl<T> From<T> for T[src][+]

impl<T, U> Into<U> for T where
    U: From<T>, [src][+]

impl<T> ToOwned for T where
    T: Clone, [src][+]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src][+]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src][+]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.