Struct SimpleDiagnostic 

pub struct SimpleDiagnostic {
    pub message: String,
    pub code: Option<String>,
    pub severity: Severity,
    pub help: Vec<Help>,
    pub labels: Option<Vec<Label>>,
    pub causes: Vec<Box<dyn Diagnostic + Send + Sync>>,
    pub related: Vec<Box<dyn Diagnostic + Send + Sync>>,
}

Diagnostic which can be created at runtime.

Fields

message: String

Defines the message being displayed along with the diagnostic.

code: Option<String>

Unique code for the diagnostic, which can be used to look up more information about the diagnostic.

severity: Severity

Defines the severity of the diagnostic. Defaults to Severity::Error.

help: Vec<Help>

Defines a list of help messages which can help or guide the user about the diagnostic.

labels: Option<Vec<Label>>

Defines a list of labels which can provide additional context about the diagnostic.

causes: Vec<Box<dyn Diagnostic + Send + Sync>>

Defines the underlying cause for the diagnostic to be raised.

related: Vec<Box<dyn Diagnostic + Send + Sync>>

Defines the diagnostics which are related to the current one, if any.

Implementations

impl SimpleDiagnostic

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

Creates a new SimpleDiagnostic with the given message content.

Examples

use error_snippet::SimpleDiagnostic;

let diag = SimpleDiagnostic::new("Whoops, that wasn't supposed to happen!");
assert_eq!(diag.to_string(), "Whoops, that wasn't supposed to happen!");
assert_eq!(diag.message, "Whoops, that wasn't supposed to happen!");

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

Sets the severity for the current diagnostic instance.

Examples

use error_snippet::{Severity, SimpleDiagnostic};

let diag = SimpleDiagnostic::new("Hmm, this could certainly be done better.")
    .with_severity(Severity::Warning);

assert_eq!(diag.message, "Hmm, this could certainly be done better.");
assert_eq!(diag.severity, Severity::Warning);

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

Sets the diagnostic code for the current instance.

Examples

use error_snippet::SimpleDiagnostic;

let diag = SimpleDiagnostic::new("Whoops, that wasn't supposed to happen!")
    .with_code("E1010");

assert_eq!(diag.message, "Whoops, that wasn't supposed to happen!");
assert_eq!(diag.code, Some(String::from("E1010")));

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

Adds a new help message to the current instance.

Examples

use error_snippet::{Help, SimpleDiagnostic};

let diag = SimpleDiagnostic::new("Whoops, that wasn't supposed to happen!")
    .with_help("have you tried restarting?");

assert_eq!(diag.message, "Whoops, that wasn't supposed to happen!");
assert_eq!(diag.help, vec![Help::new("have you tried restarting?")]);

pub fn set_help(self, help: impl Into<Help>) -> Self

Sets the help message of the current instance.

Examples

use error_snippet::{Help, SimpleDiagnostic};

let diag = SimpleDiagnostic::new("Whoops, that wasn't supposed to happen!")
    .set_help("have you tried restarting?");

assert_eq!(diag.message, "Whoops, that wasn't supposed to happen!");
assert_eq!(diag.help, vec![Help::new("have you tried restarting?")]);

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

Adds a new label to the current instance.

Examples

use std::sync::Arc;
use error_snippet::{SimpleDiagnostic, Label, NamedSource};

let source = Arc::new(NamedSource::new(
    "src/lib.rs",
    r#"fn main() -> int {
    let a = new Testing();
    let b = a.invok();

    return false;
}"#,
));

let label1 = Label::new(Some(source.clone()), 60..65, "could not find method 'invok'");
let label2 = Label::new(Some(source.clone()), 81..86, "expected 'int', found 'boolean'");

let diag = SimpleDiagnostic::new("Whoops, that wasn't supposed to happen!")
    .with_label(label1.clone())
    .with_label(label2.clone());

assert_eq!(diag.message, "Whoops, that wasn't supposed to happen!");
assert_eq!(diag.labels, Some(vec![label1, label2]));

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

Adds a list of labels to the current instance. The given labels are appended onto the existing label array in the diagnostic, so nothing is overwritten.

Examples

use std::sync::Arc;
use error_snippet::{SimpleDiagnostic, Label, NamedSource};

let source = Arc::new(NamedSource::new(
    "src/lib.rs",
    r#"fn main() -> int {
    let a = new Testing();
    let b = a.invok();

    return false;
}"#,
));

let label1 = Label::new(Some(source.clone()), 60..65, "could not find method 'invok'");
let label2 = Label::new(Some(source.clone()), 81..86, "expected 'int', found 'boolean'");

let diag = SimpleDiagnostic::new("Whoops, that wasn't supposed to happen!")
    .with_labels([label1.clone(), label2.clone()]);

assert_eq!(diag.message, "Whoops, that wasn't supposed to happen!");
assert_eq!(diag.labels, Some(vec![label1, label2]));

pub fn add_related( self, related: impl Into<Box<dyn Diagnostic + Send + Sync>>, ) -> Self

Adds a related diagnostic to the current instance.

Examples

use error_snippet::SimpleDiagnostic;

let related1 = std::io::Error::new(std::io::ErrorKind::Other, "failed to read file");
let related2 = std::io::Error::new(std::io::ErrorKind::Other, "file is unaccessible");

let diag = SimpleDiagnostic::new("failed to perform I/O operation")
    .add_related(related1)
    .add_related(related2);

assert_eq!(diag.message, "failed to perform I/O operation");
assert_eq!(diag.related.iter().map(|e| e.to_string()).collect::<Vec<_>>(), vec![
    "failed to read file".to_string(),
    "file is unaccessible".to_string()
]);

pub fn append_related( self, related: impl IntoIterator<Item = impl Into<Box<dyn Diagnostic + Send + Sync>>>, ) -> Self

Adds multiple related diagnostics to the current instance.

Examples

use error_snippet::SimpleDiagnostic;

let related1 = std::io::Error::new(std::io::ErrorKind::Other, "failed to read file");
let related2 = std::io::Error::new(std::io::ErrorKind::Other, "file is unaccessible");

let diag = SimpleDiagnostic::new("failed to perform I/O operation")
    .append_related([related1, related2]);

assert_eq!(diag.message, "failed to perform I/O operation");
assert_eq!(diag.related.iter().map(|e| e.to_string()).collect::<Vec<_>>(), vec![
    "failed to read file".to_string(),
    "file is unaccessible".to_string()
]);

pub fn add_cause( self, cause: impl Into<Box<dyn Diagnostic + Send + Sync>>, ) -> Self

Adds a causing error diagnostic to the current instance.

Examples

use error_snippet::SimpleDiagnostic;

let cause1 = std::io::Error::new(std::io::ErrorKind::Other, "failed to read file");
let cause2 = std::io::Error::new(std::io::ErrorKind::Other, "file is unaccessible");

let diag = SimpleDiagnostic::new("failed to perform I/O operation")
    .add_cause(cause1)
    .add_cause(cause2);

assert_eq!(diag.message, "failed to perform I/O operation");
assert_eq!(diag.causes.iter().map(|e| e.to_string()).collect::<Vec<_>>(), vec![
    "failed to read file".to_string(),
    "file is unaccessible".to_string()
]);

pub fn add_causes( self, causes: impl IntoIterator<Item = impl Into<Box<dyn Diagnostic + Send + Sync>>>, ) -> Self

Adds multiple causing error diagnostics to the current instance.

Examples

use error_snippet::SimpleDiagnostic;

let cause1 = std::io::Error::new(std::io::ErrorKind::Other, "failed to read file");
let cause2 = std::io::Error::new(std::io::ErrorKind::Other, "file is unaccessible");

let diag = SimpleDiagnostic::new("failed to perform I/O operation")
    .add_causes([cause1, cause2]);

assert_eq!(diag.message, "failed to perform I/O operation");
assert_eq!(diag.causes.iter().map(|e| e.to_string()).collect::<Vec<_>>(), vec![
    "failed to read file".to_string(),
    "file is unaccessible".to_string()
]);

Trait Implementations

impl Debug for SimpleDiagnostic

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

Formats the value using the given formatter.

impl Default for SimpleDiagnostic

fn default() -> SimpleDiagnostic

Returns the “default value” for a type.

impl Diagnostic for SimpleDiagnostic

fn message(&self) -> String

Defines which message to be raised to the user, when reported.

fn severity(&self) -> Severity

Diagnostic severity level.

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

Unique diagnostic code, which can be used to look up more information about the error.

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

Help messages, which can be used to provide additional information about the diagnostic.

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

Labels to attach to snippets of the source code.

fn related( &self, ) -> Box<dyn Iterator<Item = &(dyn Diagnostic + Send + Sync)> + '_>

Any related errors, which can be used to provide additional information about the diagnostic.

fn causes( &self, ) -> Box<dyn Iterator<Item = &(dyn Diagnostic + Send + Sync)> + '_>

Any errors which were the underlying cause for the diagnostic to be raised.

fn source_code(&self) -> Option<Arc<dyn Source>>

Gets the source code which the diagnostic refers to.

impl Display for SimpleDiagnostic

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

Formats the value using the given formatter.