codespan_reporting::diagnostic

Struct Label

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

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§

Source§

impl<FileId> Label<FileId>

Source

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

Create a new label.

Source

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

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

Source

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

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

Source

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

Add a message to the diagnostic.

Trait Implementations§

Source§

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

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

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

Source§

impl<FileId> StructuralPartialEq for Label<FileId>

Auto Trait Implementations§

§

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

§

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§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.