Struct Diagnostic 

pub struct Diagnostic { /* private fields */ }

A single diagnostic ready to be rendered.

Records what went wrong, where, and any extra context that helps the user act on it.

Implementations

impl Diagnostic

pub fn new(error: Error, span: Span) -> Self

Create a new error with context.

pub fn warning(error: Error, span: Span) -> Self

Create a warning attached to a code span.

pub fn file(error: Error, file_id: usize) -> Self

pub fn global(error: Error) -> Self

pub fn with_secondary(self, span: Span, message: impl Into<String>) -> Self

pub fn with_note(self, note: impl Into<Arc<str>>) -> Self

pub fn with_help(self, help: impl Into<Arc<str>>) -> Self

pub fn severity(&self) -> &Severity

pub fn error(&self) -> &Error

pub fn location(&self) -> &Location

Returns where the diagnostic points: a code span, a whole file, or the whole build.

pub fn secondary(&self) -> &[Label]

Returns the secondary labels, additional highlights that give context for the primary error.

pub fn notes(&self) -> &[Arc<str>]

Returns the free-form notes attached to this diagnostic.

pub fn help(&self) -> &Option<Arc<str>>

Returns the actionable suggestion, if one was set.

Trait Implementations

impl Clone for Diagnostic

fn clone(&self) -> Diagnostic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Diagnostic

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

Formats the value using the given formatter.

impl Display for Diagnostic

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

Formats the value using the given formatter.

impl Error for Diagnostic

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.

impl<'tokens, 'src: 'tokens, I> Error<'tokens, I> for Diagnostic

where I: ValueInput<'tokens, Token = Token<'src>, Span = Span>,

Implementation of traits for using inside chumsky parsers.

fn merge(self, other: Self) -> Self

Merge two errors that point to the same input together, combining their information.

impl From<Diagnostic> for Error

fn from(diag: Diagnostic) -> Self

Converts to this type from the input type.

impl From<Diagnostic> for String

fn from(diag: Diagnostic) -> Self

Converts to this type from the input type.

impl<'tokens, 'src: 'tokens, I> LabelError<'tokens, I, &'tokens str> for Diagnostic

where I: ValueInput<'tokens, Token = Token<'src>, Span = Span>,

fn expected_found<E>( expected: E, found: Option<MaybeRef<'tokens, Token<'src>>>, span: Span, ) -> Self

where E: IntoIterator<Item = &'tokens str>,

Create a new error describing a conflict between expected inputs and that which was actually found.

fn label_with(&mut self, label: &'tokens str)

Annotate the expected patterns within this parser with the given label.

fn merge_expected_found<E>( self, expected: E, found: Option<Maybe<<I as Input<'src>>::Token, &'src <I as Input<'src>>::Token>>, span: <I as Input<'src>>::Span, ) -> Self

where E: IntoIterator<Item = L>, Self: Error<'src, I>,

Fast path for a.merge(LabelError::expected_found(...)) that may incur less overhead by, for example, reusing allocations.

fn replace_expected_found<E>( self, expected: E, found: Option<Maybe<<I as Input<'src>>::Token, &'src <I as Input<'src>>::Token>>, span: <I as Input<'src>>::Span, ) -> Self

where E: IntoIterator<Item = L>,

Fast path for a = LabelError::expected_found(...) that may incur less overhead by, for example, reusing allocations.

fn in_context(&mut self, label: L, span: <I as Input<'src>>::Span)

Annotate this error, indicating that it occurred within the context denoted by the given label.

impl<'tokens, 'src: 'tokens, I> LabelError<'tokens, I, DefaultExpected<'tokens, Token<'src>>> for Diagnostic

where I: ValueInput<'tokens, Token = Token<'src>, Span = Span>,

fn expected_found<E>( expected: E, found: Option<MaybeRef<'tokens, Token<'src>>>, span: Span, ) -> Self

where E: IntoIterator<Item = DefaultExpected<'tokens, Token<'src>>>,

Create a new error describing a conflict between expected inputs and that which was actually found.

fn merge_expected_found<E>( self, expected: E, found: Option<Maybe<<I as Input<'src>>::Token, &'src <I as Input<'src>>::Token>>, span: <I as Input<'src>>::Span, ) -> Self

where E: IntoIterator<Item = L>, Self: Error<'src, I>,

Fast path for a.merge(LabelError::expected_found(...)) that may incur less overhead by, for example, reusing allocations.

fn replace_expected_found<E>( self, expected: E, found: Option<Maybe<<I as Input<'src>>::Token, &'src <I as Input<'src>>::Token>>, span: <I as Input<'src>>::Span, ) -> Self

where E: IntoIterator<Item = L>,

Fast path for a = LabelError::expected_found(...) that may incur less overhead by, for example, reusing allocations.

fn label_with(&mut self, label: L)

Annotate the expected patterns within this parser with the given label.

fn in_context(&mut self, label: L, span: <I as Input<'src>>::Span)

Annotate this error, indicating that it occurred within the context denoted by the given label.