Struct Diagnostic

pub struct Diagnostic {
    pub range: Range<usize>,
    pub severity: DiagnosticSeverity,
    pub message: String,
    pub source: DiagnosticSource,
    pub document_version: Option<DocumentVersion>,
}

Diagnostic attached to a byte range in a code document.

Ranges are UTF-8 byte offsets and are not normalized or clamped here. Empty and reversed ranges are representable; hit testing uses inclusive endpoints.

Examples

use ailloli_ui_editor::{Diagnostic, DiagnosticSeverity, DiagnosticSource};
let diagnostic = Diagnostic::new(2..5, DiagnosticSeverity::Warning, "unused");
assert_eq!(diagnostic.source, DiagnosticSource::Local);
assert_eq!(diagnostic.range, 2..5);

Fields

range: Range<usize>

Unvalidated UTF-8 byte range.

severity: DiagnosticSeverity

Error, warning, information, or hint level.

message: String

Exact owned human-readable message; empty is allowed.

source: DiagnosticSource

Local or language-server provenance.

document_version: Option<DocumentVersion>

Source document revision for LSP diagnostics, otherwise None by default.

Implementations

impl Diagnostic

Diagnostic constructors.

pub fn new( range: Range<usize>, severity: DiagnosticSeverity, message: impl Into<String>, ) -> Self

Creates a local diagnostic with no document version.

Examples

use ailloli_ui_editor::{Diagnostic, DiagnosticSeverity, DiagnosticSource};
let diagnostic = Diagnostic::new(0..0, DiagnosticSeverity::Hint, "");
assert_eq!(diagnostic.source, DiagnosticSource::Local);
assert_eq!(diagnostic.document_version, None);

pub fn lsp( range: Range<usize>, severity: DiagnosticSeverity, message: impl Into<String>, document_version: DocumentVersion, ) -> Self

Creates an LSP diagnostic tied to an exact document version.

Examples

use ailloli_ui_editor::{Diagnostic, DiagnosticSeverity, DiagnosticSource, DocumentVersion};
let diagnostic = Diagnostic::lsp(1..3, DiagnosticSeverity::Error, "bad", DocumentVersion(4));
assert_eq!(diagnostic.source, DiagnosticSource::Lsp);
assert_eq!(diagnostic.document_version, Some(DocumentVersion(4)));

Trait Implementations

impl Clone for Diagnostic

fn clone(&self) -> Diagnostic

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Diagnostic

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Diagnostic

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Diagnostic

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

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 Diagnostic

impl StructuralPartialEq for Diagnostic