Struct Issue 

pub struct Issue {
    pub level: Level,
    pub code: Option<String>,
    pub message: String,
    pub notes: Vec<String>,
    pub help: Option<String>,
    pub link: Option<String>,
    pub annotations: Vec<Annotation>,
    pub edits: HashMap<FileId, Vec<TextEdit>>,
}

Represents an issue identified in the code.

Fields

level: Level

The severity level of the issue.

code: Option<String>

An optional code associated with the issue.

message: String

The main message describing the issue.

notes: Vec<String>

Additional notes related to the issue.

help: Option<String>

An optional help message suggesting possible solutions or further actions.

link: Option<String>

An optional link to external resources for more information about the issue.

annotations: Vec<Annotation>

Annotations associated with the issue, providing additional context or highlighting specific code spans.

edits: HashMap<FileId, Vec<TextEdit>>

Text edits that can be applied to fix the issue, grouped by file.

Implementations

impl Issue

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

Creates a new issue with the given level and message.

Examples

use mago_reporting::{Issue, Level};

let issue = Issue::new(Level::Error, "This is an error");

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

Creates a new error issue with the given message.

Examples

use mago_reporting::Issue;

let issue = Issue::error("This is an error");

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

Creates a new warning issue with the given message.

Examples

use mago_reporting::Issue;

let issue = Issue::warning("This is a warning");

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

Creates a new help issue with the given message.

Examples

use mago_reporting::Issue;

let issue = Issue::help("This is a help message");

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

Creates a new note issue with the given message.

Examples

use mago_reporting::Issue;

let issue = Issue::note("This is a note");

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

Adds a code to this issue.

Examples

use mago_reporting::{Issue, Level};

let issue = Issue::error("This is an error").with_code("E0001");

pub fn with_annotation(self, annotation: Annotation) -> Self

Add an annotation to this issue.

Examples

use mago_reporting::{Issue, Annotation, AnnotationKind};
use mago_database::file::FileId;
use mago_span::Span;
use mago_span::Position;

let file = FileId::zero();
let start = Position::new(0);
let end = Position::new(5);
let span = Span::new(file, start, end);

let issue = Issue::error("This is an error").with_annotation(Annotation::primary(span));

pub fn with_annotations( self, annotation: impl IntoIterator<Item = Annotation>, ) -> Self

pub fn with_note(self, note: impl Into<String>) -> Self

Add a note to this issue.

Examples

use mago_reporting::Issue;

let issue = Issue::error("This is an error").with_note("This is a note");

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

Add a help message to this issue.

This is useful for providing additional context to the user on how to resolve the issue.

Examples

use mago_reporting::Issue;

let issue = Issue::error("This is an error").with_help("This is a help message");

pub fn with_link(self, link: impl Into<String>) -> Self

Add a link to this issue.

Examples

use mago_reporting::Issue;

let issue = Issue::error("This is an error").with_link("https://example.com");

pub fn with_edit(self, file_id: FileId, edit: TextEdit) -> Self

Add a single edit to this issue.

pub fn with_file_edits(self, file_id: FileId, edits: Vec<TextEdit>) -> Self

Add multiple edits to this issue.

pub fn take_edits(&mut self) -> HashMap<FileId, Vec<TextEdit>>

Take the edits from this issue.

Trait Implementations

impl Clone for Issue

fn clone(&self) -> Issue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Issue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Issue

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Issue> for Diagnostic<FileId>

fn from(issue: Issue) -> Diagnostic<FileId>

Converts to this type from the input type.

impl FromIterator<Issue> for IssueCollection

fn from_iter<T: IntoIterator<Item = Issue>>(iter: T) -> Self

Creates a value from an iterator.

impl IntoIterator for Issue

type Item = Issue

The type of the elements being iterated over.

type IntoIter = Once<Issue>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Issue

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Issue

impl StructuralPartialEq for Issue