Skip to main content

SpanLabel

Struct SpanLabel 

Source
pub struct SpanLabel {
    pub span: Span<BytePos>,
    pub message: String,
    pub primary: bool,
    pub file: Option<SourceFileId>,
}
Expand description

One underlined region of the user’s source, and what to say about it.

§file: when a label is not about the module under check

A [codespan_reporting::diagnostic::Label] needs a file id as well as a byte range. Most labels don’t carry one themselves: a phase only ever sees one module, so its spans belong to the file that module was read from, and check_package — the only place that knows which file that is — supplies it for the whole diagnostic at render time. file: None is that case, and it covers everything built before ERR-5.

Some is the escape hatch: a label built from a SourceSpan cloned out of an Interface (via Interface::source_span) already carries its own file, generally a different one from the module being checked — “the annotation you are contradicting is over there, in Basics” — and that id is used verbatim instead of the diagnostic’s.

primary is the rustc distinction, and it applies independently of file: the caret under the thing that is wrong is primary even when it is local, and “defined here” in another file is secondary even though it is the only label pointing into that file.

Fields§

§span: Span<BytePos>§message: String§primary: bool§file: Option<SourceFileId>

Trait Implementations§

Source§

impl Clone for SpanLabel

Source§

fn clone(&self) -> SpanLabel

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SpanLabel

Source§

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

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

impl PartialEq for SpanLabel

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SpanLabel

Auto Trait Implementations§

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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.