Struct RelatedLabel 

pub struct RelatedLabel {
    pub severity: Severity,
    pub message: Cow<'static, str>,
    pub labels: Vec<Label>,
    pub help: Option<Cow<'static, str>>,
    pub file: Option<Arc<SourceFile>>,
}

This type is used to associate a more complex label or set of labels with some other error.

In particular, it is used to reference related bits of source code distinct from that of the original error. A related label can have a distinct severity, its own message, and its own sub-labels, and may reference code in a completely different source file that the original error.

Fields

severity: Severity

The severity for this related label

message: Cow<'static, str>

The message for this label

labels: Vec<Label>

The sub-labels for this label

help: Option<Cow<'static, str>>

If provided as a standalone diagnostic, the help message to provide

file: Option<Arc<SourceFile>>

The source file to use when rendering source spans of this label as snippets.

Implementations

impl RelatedLabel

pub fn new<S>(severity: Severity, message: S) -> Self

where Cow<'static, str>: From<S>,

pub fn error<S>(message: S) -> Self

where Cow<'static, str>: From<S>,

pub fn warning<S>(message: S) -> Self

where Cow<'static, str>: From<S>,

pub fn advice<S>(message: S) -> Self

where Cow<'static, str>: From<S>,

pub fn with_source_file(self, file: Option<Arc<SourceFile>>) -> Self

pub fn with_labeled_span<S>(self, span: SourceSpan, message: S) -> Self

where Cow<'static, str>: From<S>,

pub fn with_label(self, label: Label) -> Self

pub fn with_labels<I>(self, labels: I) -> Self

where I: IntoIterator<Item = Label>,

pub fn with_help<S>(self, help: S) -> Self

where Cow<'static, str>: From<S>,

Trait Implementations

impl Debug for RelatedLabel

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

Formats the value using the given formatter.

impl Diagnostic for RelatedLabel

fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for RelatedLabel

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

Formats the value using the given formatter.

impl Error for RelatedLabel

Available on crate feature std only.

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.