Struct lisbeth_error::error::AnnotatedError

pub struct AnnotatedError { /* fields omitted */ }

An error report with annotations.

This error report is created with the precise span at which the error occurs and a simple message explaining the situation. It can then be improved by adding more information.

Example

The following code shows how to create a simple error report.

use lisbeth_error::{
    error::AnnotatedError,
    span::{Span, SpannedStr},
};

let file = SpannedStr::input_file("The cat are on the table.");

let cat = file.split_at(4).1.split_at(3).0;
let are = file.split_at(8).1.split_at(3).0;

let report = AnnotatedError::new(are.span(), "Conjugation error")
    .with_annotation(cat.span(), "`cat` is singular,")
    .with_annotation(are.span(), "but `are` is used only for plural subject");

Implementations

impl AnnotatedError

pub fn new<Msg>(span: Span, msg: Msg) -> AnnotatedError where
    Msg: ToString, 

Constructs a new report.

span represents the precise location at which the error is encountered, msg describes the issue. msg can be either a static string slice or a String.

pub fn with_annotation<Msg>(self, span: Span, msg: Msg) -> AnnotatedError where
    Msg: ToString, 

Adds a new annotation at a given span to the report.

pub fn span(&self) -> Span

Returns the span at which the error is encountered.

Trait Implementations

impl Clone for AnnotatedError

pub fn clone(&self) -> AnnotatedError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnnotatedError

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

Formats the value using the given formatter.

impl PartialEq<AnnotatedError> for AnnotatedError

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for AnnotatedError