Struct reporting::Report

pub struct Report {
    pub location: Option<Location>,
    pub severity: Severity,
    pub message: String,
}

A diagnostic report.

Fields

location: Option<Location>

severity: Severity

message: String

Implementations

impl Report

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

Creates a new Report with the given severity and message. Defaults with no Location.

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

Creates a Severity::Bug report with the given message.

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

Creates a Severity::Error report with the given message.

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

Creates a Severity::Warning report with the given message.

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

Creates a Severity::Note report with the given message.

pub fn location(self, location: impl Into<Option<Location>>) -> Self

Adds a location to this diagnostic report.

Examples found in repository

examples/basic.rs (line 13)

fn main() {
    let file = File::new("test.txt", "import stds;");
    let styles = Styles::styled();

    print!(
        "{}",
        Renderer::new(
            &styles,
            &[
                error!("Could not find package `{}`", "stds")
                    .location(Location::new(file.clone(), 7)),
                note!("Perhaps you meant `std`?")
            ]
        )
    );
}

pub fn render<'a>(&'a self, styles: &'a Styles) -> Renderer<'a>

Creates a renderer for a single diagnostic report.

Trait Implementations

impl Clone for Report

fn clone(&self) -> Report

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Report

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

Formats the value using the given formatter.

impl PartialEq for Report

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

impl StructuralPartialEq for Report