Struct Annotation 

pub struct Annotation {
    pub message: Option<String>,
    pub kind: AnnotationKind,
    pub span: Span,
}

An annotation associated with an issue, providing additional context or highlighting specific code spans.

Fields

message: Option<String>

An optional message associated with the annotation.

kind: AnnotationKind

The kind of annotation.

span: Span

The code span that the annotation refers to.

Implementations

impl Annotation

pub fn new(kind: AnnotationKind, span: Span) -> Self

Creates a new annotation with the given kind and span.

Examples

use mago_reporting::{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 annotation = Annotation::new(AnnotationKind::Primary, span);

pub fn primary(span: Span) -> Self

Creates a new primary annotation with the given span.

Examples

use mago_reporting::{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 annotation = Annotation::primary(span);

pub fn secondary(span: Span) -> Self

Creates a new secondary annotation with the given span.

Examples

use mago_reporting::{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 annotation = Annotation::secondary(span);

pub fn with_message(self, message: impl Into<String>) -> Self

Sets the message of this annotation.

Examples

use mago_reporting::{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 annotation = Annotation::primary(span).with_message("This is a primary annotation");

pub fn is_primary(&self) -> bool

Returns true if this annotation is a primary annotation.

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Annotation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Annotation> for Label<FileId>

fn from(annotation: Annotation) -> Label<FileId>

Converts to this type from the input type.

impl Hash for Annotation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Annotation

fn cmp(&self, other: &Annotation) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Annotation

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

fn partial_cmp(&self, other: &Annotation) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Annotation

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 Annotation

impl StructuralPartialEq for Annotation