Struct Diagnostic 

pub struct Diagnostic<E = Error> {
    pub error: Box<E>,
    pub detail: Box<Detail>,
}

Error diagnostics. Display user-friendly error snippets with Display.

A diagnostic is a wrapper around an error with extra contextual metadata: the source, the declaration name, the span, …

Fields

error: Box<E>

detail: Box<Detail>

Implementations

impl<E> Diagnostic<E>

pub fn with_source(self, source: String) -> Self

Provide the source code from which the error was emitted. You should also provide the span with Self::with_span.

pub fn with_span(self, span: Span) -> Self

Provide the span (chunk of source code) where the error originated. You should also provide the source with Self::with_source. Subsequent calls to this function do not override the span.

pub fn with_declaration(self, decl: String) -> Self

Provide the declaration in which the error originated.

pub fn with_output(self, out: String) -> Self

Provide the output code that was generated, even if an error was emitted.

pub fn with_module_path( self, path: ModulePath, disp_name: Option<String>, ) -> Self

Provide the module path in which the error was emitted. The disp_name is usually the file name of the module.

pub fn with_sourcemap(self, sourcemap: &impl SourceMap) -> Self

Add metadata collected by the sourcemap. If the mangled declaration name was set, this will automatically add the source, the module path and the declaration name.

impl<E: Error> Diagnostic<E>

pub fn render_plain(&self) -> String

pub fn render_colored(&self) -> String

impl<E> Diagnostic<E>

pub fn colored(&self, colored: bool) -> ColoredDiagnostic<'_, E>

A std::fmt::Display adapter to get a colored output (with ANSI codes).

Diagnostics auto-detect if colors are supported using anstream. With this adapter, you can force a colored or non-colored output.

Trait Implementations

impl<E: Debug> Debug for Diagnostic<E>

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

Formats the value using the given formatter.

impl<E: Error> Display for Diagnostic<E>

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

Formats the value using the given formatter.

impl<E: Error> Error for Diagnostic<E>

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 From<CondCompError> for Diagnostic<Error>

fn from(error: CondCompError) -> Self

Converts to this type from the input type.

impl From<Diagnostic> for ResolveError

fn from(source: Diagnostic<Error>) -> Self

Converts to this type from the input type.

impl From<Diagnostic> for Error

fn from(source: Diagnostic<Error>) -> Self

Converts to this type from the input type.

impl From<Error> for Diagnostic<Error>

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Diagnostic<Error>

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<ImportError> for Diagnostic<Error>

fn from(error: ImportError) -> Self

Converts to this type from the input type.

impl From<ResolveError> for Diagnostic<Error>

fn from(error: ResolveError) -> Self

Converts to this type from the input type.

impl From<TomlError> for Diagnostic<Error>

fn from(error: TomlError) -> Self

Converts to this type from the input type.

impl From<UsageError> for Diagnostic<Error>

fn from(error: UsageError) -> Self

Converts to this type from the input type.

impl From<ValidateError> for Diagnostic<Error>

fn from(error: ValidateError) -> Self

Converts to this type from the input type.