Struct Highlight 

pub struct Highlight {
    pub style: LabelStyle,
    pub fragment: Fragment,
    pub message: String,
}

Available on crate feature reporting only.

A highlighted section of a Source that’s used in a Diagnostic.

Fields

style: LabelStyle

The style/importance of this Highlight. Highlights with LabelStyle::Primary are given priority when being displayed.

fragment: Fragment

The Fragment containing the relevant section of code.

message: String

The message attached to this Highlight. This can be empty, in which case the Fragment will just be underlined when displayed.

Implementations

impl Highlight

pub fn primary(fragment: Fragment, message: impl Into<String>) -> Self

Construct a new Highlight with LabelStyle::Primary.

pub fn secondary(fragment: Fragment, message: impl Into<String>) -> Self

Construct a new Highlight with LabelStyle::Secondary.

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

Builder style function to set the Highlight::message.

Trait Implementations

impl Clone for Highlight

fn clone(&self) -> Highlight

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Highlight

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

Formats the value using the given formatter.

impl From<Highlight> for Label<SourceId>

fn from(value: Highlight) -> Self

Converts to this type from the input type.