Struct Diagnostic 

pub struct Diagnostic {
    pub title: String,
    pub text: Option<String>,
    pub level: Level,
    pub location: Option<TextSpan>,
    pub hint: Option<String>,
    pub content: Option<String>,
}

Represents a diagnostic message, which includes information about an error or warning and can be pretty-printed to the console.

Fields

title: String

The title or summary of the diagnostic message.

text: Option<String>

An optional detailed description of the diagnostic message.

level: Level

The severity level of the diagnostic message (e.g., Error, Warning).

location: Option<TextSpan>

The location in the source code where the error or warning occurred, represented as a TextSpan.

hint: Option<String>

An optional hint that provides additional guidance on resolving the issue.

content: Option<String>

The content of the source code related to the diagnostic.

Implementations

impl Diagnostic

pub fn log_pretty(&self, buff: &mut BufWriter<Stderr>)

Logs the diagnostic in a human-readable format to the provided buffer.

The message is colored according to its severity level, and the source code around the error location (if available) is highlighted.

Arguments

• buff - A mutable reference to a BufWriter that writes to stderr.

Example

use std::io::BufWriter;
use log::Level;
use roan_error::{Diagnostic, Position, TextSpan};
let diagnostic = Diagnostic {
    title: "Syntax Error".to_string(),
    text: None,
    level: Level::Error,
    location: Some(TextSpan::new(Position::new(1, 1, 0), Position::new(1, 5, 4), "test".to_string())),
    hint: None,
    content: Some("let x = ;".to_string()),
};

let mut buff = BufWriter::new(std::io::stderr());
diagnostic.log_pretty(&mut buff);

pub fn print_hint(&self, buff: &mut BufWriter<Stderr>)

Prints a hint message (if available) to the provided buffer.

Arguments

• buff - A mutable reference to a BufWriter that writes to stderr.

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<(), Error>

Formats the value using the given formatter.

impl PartialEq for Diagnostic

fn eq(&self, other: &Diagnostic) -> 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 Diagnostic

impl StructuralPartialEq for Diagnostic