Struct Help

pub struct Help {
    pub message: String,
    pub suggestions: Vec<Suggestion>,
}

Represents a help message, which can be attached to diagnostics to aid users.

Each help message is accompanied by zero-or-more suggestions, which can guide the user to change some part of the source code, in order to fix the diagnostic.

Fields

message: String

Defines the actual message to print in the footer.

suggestions: Vec<Suggestion>

A list of zero-or-more suggestions to apply to the original source code.

Implementations

impl Help

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

Creates a new Help with the given message.

Examples

use error_snippet::Help;

let help = Help::new("have you checked your syntax?");

assert_eq!(help.message, "have you checked your syntax?");
assert_eq!(help.suggestions, vec![]);

pub fn with_suggestion(self, suggestion: impl Into<Suggestion>) -> Self

Adds the given suggestion to the help message.

Examples

use std::sync::Arc;
use error_snippet::{Help, NamedSource, SourceRange, Suggestion};

let source = Arc::new(NamedSource::new(
    "src/lib.rs",
    r#"fn main() -> int {
    /// doc comment
    let a = Testing::new();
    let b = a.invoke();

    return 0;
}"#,
));

let source_range = SourceRange::new(source.clone(), 23..38);
let suggestion = Suggestion::delete(source_range);

let help = Help::new("remove this doc comment")
    .with_suggestion(suggestion.clone());

assert_eq!(help.suggestions, vec![suggestion]);

pub fn with_suggestions( self, suggestions: impl IntoIterator<Item = Suggestion>, ) -> Self

Adds the given suggestions to the help message.

Examples

use std::sync::Arc;
use error_snippet::{Help, NamedSource, SourceRange, Suggestion};

let source = Arc::new(NamedSource::new(
    "src/lib.rs",
    r#"fn main() -> int {
    let a = Testing::new();
    let b = a.invoke();

    return (0);
}"#,
));

let suggestion1 = Suggestion::delete(SourceRange::new(source.clone(), 83..84));
let suggestion2 = Suggestion::delete(SourceRange::new(source.clone(), 85..86));

let help = Help::new("remove this doc comment")
    .with_suggestions([suggestion1.clone(), suggestion2.clone()]);

assert_eq!(help.suggestions, vec![suggestion1, suggestion2]);

Trait Implementations

impl Clone for Help

fn clone(&self) -> Help

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Help

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

Formats the value using the given formatter.

impl From<&String> for Help

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&str> for Help

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for Help

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for Help

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

impl StructuralPartialEq for Help