Struct rslint_core::Diagnostic [−][src]
pub struct Diagnostic {
pub file_id: usize,
pub severity: Severity,
pub code: Option<String>,
pub title: String,
pub tag: Option<DiagnosticTag>,
pub primary: Option<SubDiagnostic>,
pub children: Vec<SubDiagnostic, Global>,
pub suggestions: Vec<CodeSuggestion, Global>,
pub footers: Vec<Footer, Global>,
}
Expand description
A diagnostic message that can give information like errors or warnings.
Fields
file_id: usize
severity: Severity
code: Option<String>
title: String
tag: Option<DiagnosticTag>
primary: Option<SubDiagnostic>
children: Vec<SubDiagnostic, Global>
suggestions: Vec<CodeSuggestion, Global>
Implementations
Creates a new Diagnostic
with the Error
severity.
Creates a new Diagnostic
with the Warning
severity.
Creates a new Diagnostic
with the Help
severity.
Creates a new Diagnostic
with the Note
severity.
Creates a new Diagnostic
that will be used in a builder-like way
to modify labels, and suggestions.
pub fn new_with_code(
file_id: usize,
severity: Severity,
title: impl Into<String>,
code: Option<String>
) -> Diagnostic
pub fn new_with_code(
file_id: usize,
severity: Severity,
title: impl Into<String>,
code: Option<String>
) -> Diagnostic
Creates a new Diagnostic
with an error code that will be used in a builder-like way
to modify labels, and suggestions.
Overwrites the severity of this diagnostic.
Marks this diagnostic as deprecated code, which will be displayed in the language server.
This does not have any influence on the diagnostic rendering.
Marks this diagnostic as unnecessary code, which will be displayed in the language server.
This does not have any influence on the diagnostic rendering.
Attaches a label to this Diagnostic
, that will point to another file
that is provided.
Attaches a label to this Diagnostic
.
The given span has to be in the file that was provided while creating this Diagnostic
.
Attaches a primary label to this Diagnostic
.
Attaches a secondary label to this Diagnostic
.
pub fn suggestion_in_file(
self,
span: impl Span,
msg: &str,
suggestion: impl Into<String>,
applicability: Applicability,
file: usize
) -> Diagnostic
pub fn suggestion_in_file(
self,
span: impl Span,
msg: &str,
suggestion: impl Into<String>,
applicability: Applicability,
file: usize
) -> Diagnostic
Prints out a message that suggests a possible solution, that is in another
file as this Diagnostic
, to the error.
If the message plus the suggestion is longer than 25 chars,
the suggestion is displayed as a new children of this Diagnostic
,
otherwise it will be inlined with the other labels.
A suggestion is displayed like:
try adding a `;`: console.log();
or in a separate multiline suggestion
The message should not contain the :
because it’s added automatically.
The suggestion will automatically be wrapped inside two backticks.
pub fn suggestion(
self,
span: impl Span,
msg: &str,
suggestion: impl Into<String>,
applicability: Applicability
) -> Diagnostic
pub fn suggestion(
self,
span: impl Span,
msg: &str,
suggestion: impl Into<String>,
applicability: Applicability
) -> Diagnostic
Prints out a message that suggests a possible solution to the error.
If the message plus the suggestion is longer than 25 chars,
the suggestion is displayed as a new children of this Diagnostic
,
otherwise it will be inlined with the other labels.
A suggestion is displayed like:
try adding a `;`: console.log();
or in a separate multiline suggestion
The message should not contain the :
because it’s added automatically.
The suggestion will automatically be wrapped inside two backticks.
pub fn suggestion_full(
self,
span: impl Span,
msg: &str,
suggestion: impl Into<String>,
applicability: Applicability
) -> Diagnostic
pub fn suggestion_full(
self,
span: impl Span,
msg: &str,
suggestion: impl Into<String>,
applicability: Applicability
) -> Diagnostic
Add a suggestion which is always shown in the Full style.
pub fn suggestion_inline(
self,
span: impl Span,
msg: &str,
suggestion: impl Into<String>,
applicability: Applicability
) -> Diagnostic
pub fn suggestion_inline(
self,
span: impl Span,
msg: &str,
suggestion: impl Into<String>,
applicability: Applicability
) -> Diagnostic
Add a suggestion which is always shown in the Inline style.
pub fn suggestion_no_code(
self,
span: impl Span,
msg: &str,
applicability: Applicability
) -> Diagnostic
pub fn suggestion_no_code(
self,
span: impl Span,
msg: &str,
applicability: Applicability
) -> Diagnostic
Add a suggestion which does not have a suggestion code.
pub fn indel_suggestion(
self,
indels: impl IntoIterator<Item = Indel>,
span: impl Span,
msg: &str,
applicability: Applicability
) -> Diagnostic
pub fn suggestion_with_labels(
self,
span: impl Span,
msg: &str,
suggestion: impl Into<String>,
applicability: Applicability,
labels: impl IntoIterator<Item = impl Span>
) -> Diagnostic
pub fn suggestion_with_labels(
self,
span: impl Span,
msg: &str,
suggestion: impl Into<String>,
applicability: Applicability,
labels: impl IntoIterator<Item = impl Span>
) -> Diagnostic
Add a suggestion with info labels which point to places in the suggestion.
The label ranges are relative to the start of the span, not relative to the original code
pub fn suggestion_with_src_labels(
self,
span: impl Span,
msg: &str,
suggestion: impl Into<String>,
applicability: Applicability,
labels: impl IntoIterator<Item = impl Span>
) -> Diagnostic
pub fn suggestion_with_src_labels(
self,
span: impl Span,
msg: &str,
suggestion: impl Into<String>,
applicability: Applicability,
labels: impl IntoIterator<Item = impl Span>
) -> Diagnostic
Add a suggestion with info labels which point to places in the suggestion.
The label ranges are relative to the source code, not relative to the original code
Adds a footer to this Diagnostic
, which will be displayed under the actual error.
Adds a footer to this Diagnostic
, with the Help
severity.
Adds a footer to this Diagnostic
, with the Note
severity.
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for Diagnostic
impl Send for Diagnostic
impl Sync for Diagnostic
impl Unpin for Diagnostic
impl UnwindSafe for Diagnostic
Blanket Implementations
Mutably borrows from an owned value. Read more
Whether this implementor has acknowledged the 1.1.0 update to
unerase
’s documented implementation requirements. Read more