Struct Suggestion 

pub struct Suggestion {
    pub span: SourceSpan,
    pub replacement: String,
}

A machine-actionable fix for a Diagnostic.

A Suggestion says “replace the bytes at this SourceSpan with this text”: it is structured data a tool can apply automatically, as opposed to the prose advice carried by DiagnosticAnnotation::Help. Backends consume it without re-parsing: the CLI can print a fix-it diff and an LSP can surface it as a code action keyed on the same span.

Two edge cases fall out of the replace-the-span model and are intentional:

• an empty replacement deletes the bytes covered by span;
• a zero-length span (start == end) inserts replacement at that offset without removing anything.

Examples

use std::path::PathBuf;

use mos_core::{SourceSpan, Suggestion};

let span = SourceSpan::new(PathBuf::from("main.mos"), 4, 10);
let fix = Suggestion::new(span, "@intro");

assert_eq!(fix.replacement, "@intro");

Fields

span: SourceSpan

The source range the fix replaces. A zero-length span (start == end) marks a pure insertion point.

replacement: String

The text to substitute for the bytes covered by span. An empty string deletes that range.

Implementations

impl Suggestion

pub fn new(span: SourceSpan, replacement: impl Into<String>) -> Self

Construct a suggestion replacing span with replacement.

Examples

use std::path::PathBuf;

use mos_core::{SourceSpan, Suggestion};

let span = SourceSpan::new(PathBuf::from("main.mos"), 0, 3);
let fix = Suggestion::new(span, "set".to_owned());

assert_eq!(fix.span.start(), 0);

Trait Implementations

impl Clone for Suggestion

fn clone(&self) -> Suggestion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Suggestion

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

Formats the value using the given formatter.

impl Eq for Suggestion

impl PartialEq for Suggestion

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