Struct MietteDiagnostic

pub struct MietteDiagnostic {
    pub message: String,
    pub code: Option<String>,
    pub severity: Option<Severity>,
    pub help: Option<String>,
    pub url: Option<String>,
    pub labels: Option<Vec<LabeledSpan>>,
}

Diagnostic that can be created at runtime.

Fields

message: String

Displayed diagnostic message

code: Option<String>

Unique diagnostic code 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 will work just fine

severity: Option<Severity>

Diagnostic severity. Intended to be used by ReportHandlers to change the way different Diagnostics are displayed. Defaults to Severity::Error

help: Option<String>

Additional help text related to this Diagnostic

url: Option<String>

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

labels: Option<Vec<LabeledSpan>>

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

Implementations

impl MietteDiagnostic

pub fn new(message: impl Into<String>) -> Self

Create a new dynamic diagnostic with the given message.

Examples

use miette::{Diagnostic, MietteDiagnostic, Severity};

let diag = MietteDiagnostic::new("Oops, something went wrong!");
assert_eq!(diag.to_string(), "Oops, something went wrong!");
assert_eq!(diag.message, "Oops, something went wrong!");

pub fn with_code(self, code: impl Into<String>) -> Self

Return new diagnostic with the given code.

Examples

use miette::{Diagnostic, MietteDiagnostic};

let diag = MietteDiagnostic::new("Oops, something went wrong!").with_code("foo::bar::baz");
assert_eq!(diag.message, "Oops, something went wrong!");
assert_eq!(diag.code, Some("foo::bar::baz".to_string()));

pub fn with_severity(self, severity: Severity) -> Self

Return new diagnostic with the given severity.

Examples

use miette::{Diagnostic, MietteDiagnostic, Severity};

let diag = MietteDiagnostic::new("I warn you to stop!").with_severity(Severity::Warning);
assert_eq!(diag.message, "I warn you to stop!");
assert_eq!(diag.severity, Some(Severity::Warning));

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

Return new diagnostic with the given help message.

Examples

use miette::{Diagnostic, MietteDiagnostic};

let diag = MietteDiagnostic::new("PC is not working").with_help("Try to reboot it again");
assert_eq!(diag.message, "PC is not working");
assert_eq!(diag.help, Some("Try to reboot it again".to_string()));

pub fn with_url(self, url: impl Into<String>) -> Self

Return new diagnostic with the given URL.

Examples

use miette::{Diagnostic, MietteDiagnostic};

let diag = MietteDiagnostic::new("PC is not working")
    .with_url("https://letmegooglethat.com/?q=Why+my+pc+doesn%27t+work");
assert_eq!(diag.message, "PC is not working");
assert_eq!(
    diag.url,
    Some("https://letmegooglethat.com/?q=Why+my+pc+doesn%27t+work".to_string())
);

pub fn with_label(self, label: impl Into<LabeledSpan>) -> Self

Return new diagnostic with the given label.

Discards previous labels

Examples

use miette::{Diagnostic, LabeledSpan, MietteDiagnostic};

let source = "cpp is the best language";

let label = LabeledSpan::at(0..3, "This should be Rust");
let diag = MietteDiagnostic::new("Wrong best language").with_label(label.clone());
assert_eq!(diag.message, "Wrong best language");
assert_eq!(diag.labels, Some(vec![label]));

pub fn with_labels(self, labels: impl IntoIterator<Item = LabeledSpan>) -> Self

Return new diagnostic with the given labels.

Discards previous labels

Examples

use miette::{Diagnostic, LabeledSpan, MietteDiagnostic};

let source = "helo wrld";

let labels = vec![
    LabeledSpan::at_offset(3, "add 'l'"),
    LabeledSpan::at_offset(6, "add 'r'"),
];
let diag = MietteDiagnostic::new("Typos in 'hello world'").with_labels(labels.clone());
assert_eq!(diag.message, "Typos in 'hello world'");
assert_eq!(diag.labels, Some(labels));

pub fn and_label(self, label: impl Into<LabeledSpan>) -> Self

Return new diagnostic with new label added to the existing ones.

Examples

use miette::{Diagnostic, LabeledSpan, MietteDiagnostic};

let source = "helo wrld";

let label1 = LabeledSpan::at_offset(3, "add 'l'");
let label2 = LabeledSpan::at_offset(6, "add 'r'");
let diag = MietteDiagnostic::new("Typos in 'hello world'")
    .and_label(label1.clone())
    .and_label(label2.clone());
assert_eq!(diag.message, "Typos in 'hello world'");
assert_eq!(diag.labels, Some(vec![label1, label2]));

pub fn and_labels(self, labels: impl IntoIterator<Item = LabeledSpan>) -> Self

Return new diagnostic with new labels added to the existing ones.

Examples

use miette::{Diagnostic, LabeledSpan, MietteDiagnostic};

let source = "helo wrld";

let label1 = LabeledSpan::at_offset(3, "add 'l'");
let label2 = LabeledSpan::at_offset(6, "add 'r'");
let label3 = LabeledSpan::at_offset(9, "add '!'");
let diag = MietteDiagnostic::new("Typos in 'hello world!'")
    .and_label(label1.clone())
    .and_labels([label2.clone(), label3.clone()]);
assert_eq!(diag.message, "Typos in 'hello world!'");
assert_eq!(diag.labels, Some(vec![label1, label2, label3]));

Trait Implementations

impl Clone for MietteDiagnostic

fn clone(&self) -> MietteDiagnostic

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MietteDiagnostic

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

Formats the value using the given formatter.

impl Diagnostic for MietteDiagnostic

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 labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

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

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

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

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 MietteDiagnostic

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

Formats the value using the given formatter.

impl Error for MietteDiagnostic

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 PartialEq for MietteDiagnostic

fn eq(&self, other: &MietteDiagnostic) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for MietteDiagnostic

impl StructuralPartialEq for MietteDiagnostic