Module diagnostics

Modules

• highlighters
  This module provides a trait for creating custom syntax highlighters that highlight Diagnostic source code with ANSI escape sequences when rendering with the GraphicalReportHighlighter.

Macros

• bail
  Return early with an error.
• diagnostic
  Construct a MietteDiagnostic in more user-friendly way.
• ensure
  Return early with an error if a condition is not satisfied.
• miette
  Construct an ad-hoc Report.

Structs

• DebugReportHandler
  ReportHandler that renders plain text and avoids extraneous graphics. It’s optimized for screen readers and braille users, but is also used in any non-graphical environments, such as non-TTY output.
• ErrReport
  Core Diagnostic wrapper type.
• Error
  Core Diagnostic wrapper type.
• GraphicalReportHandler
  A ReportHandler that displays a given Report in a quasi-graphical way, using terminal colors, unicode drawing characters, and other such things.
• GraphicalTheme
  Theme used by GraphicalReportHandler to render fancy Diagnostic reports.
• InstallError
  Error indicating that set_hook() was unable to install the provided ErrorHook.
• JSONReportHandler
  ReportHandler that renders JSON output. It’s a machine-readable output.
• LabeledSpan
  A labeled SourceSpan.
• MietteDiagnostic
  Diagnostic that can be created at runtime.
• MietteHandler
  A ReportHandler that displays a given Report in a quasi-graphical way, using terminal colors, unicode drawing characters, and other such things.
• MietteHandlerOpts
  Create a custom MietteHandler from options.
• MietteSpanContents
  Basic implementation of the SpanContents trait, for convenience.
• NamedSource
  Utility struct for when you have a regular SourceCode type that doesn’t implement name. For example String. Or if you want to override the name returned by the SourceCode.
• NarratableReportHandler
  ReportHandler that renders plain text and avoids extraneous graphics. It’s optimized for screen readers and braille users, but is also used in any non-graphical environments, such as non-TTY output.
• Report
  Core Diagnostic wrapper type.
• SourceOffset
  Newtype that represents the ByteOffset from the beginning of a SourceCode
• SourceSpan
  Span within a SourceCode
• ThemeCharacters
  Characters to be used when drawing when using GraphicalReportHandler.
• ThemeStyles
  Styles for various parts of graphical rendering for the GraphicalReportHandler.

Enums

• MietteError
  Error enum for miette. Used by certain operations in the protocol.
• RgbColors
  Settings to control the color format used for graphical rendering.
• Severity
  Diagnostic severity. Intended to be used by ReportHandlers to change the way different Diagnostics are displayed. Defaults to Severity::Error.

Traits

• Context
  Provides the wrap_err() method for Result.
• Diagnostic
  Adds rich metadata to your Error that can be used by Report to print really nice and human-friendly error messages.
• EyreContext
  Error Report Handler trait for customizing miette::Report
• IntoDiagnostic
  Convenience trait that adds a .into_diagnostic() method that converts a type implementing std::error::Error to a Result<T, Report>.
• ReportHandler
  Error Report Handler trait for customizing miette::Report
• SourceCode
  Represents readable source code of some sort.
• SpanContents
  Contents of a SourceCode covered by SourceSpan.
• WrapErr
  Provides the wrap_err() method for Result.

Functions

• set_hook
  Set the error hook.
• set_panic_hook
  Tells miette to render panics using its rendering engine.
• setup_miette

Type Aliases

• ByteOffset
  “Raw” type for the byte offset from the beginning of a SourceCode.
• ErrorHook
• Result
  type alias for Result<T, Report>

Derive Macros

• Diagnostic