engine/elide.runtime.diag/Diagnostic

Diagnostic

@Serializable
@JvmRecord
data class Diagnostic : Record

Diagnostic

Describes a diagnostic event which was emitted by a tool such as a compiler or linter; such events carry a severity along with some source and span information.

Diagnostics take the shape created by a given tool. Tools may elect to fill a subset of all properties.

Types

Link copied to clipboard
object Companion

Factory methods and builders for Diagnostic objects.

Properties

Link copied to clipboard
@JvmField
val advice: String? = null

Optional corrective action to take, if any

Link copied to clipboard
@JvmField
val id: String? = null

ID or class for this diagnostic type, if supported.

Link copied to clipboard
@JvmField
val lang: String? = null

Name of a guest language from which this diagnostic arose, if known.

Link copied to clipboard
@JvmField
val message: String? = null

Message associated with the diagnostic

Link copied to clipboard
@JvmField
val position: SourceLocation? = null

Position in the source for the diagnostic, if any

Link copied to clipboard
@JvmField
val reference: SourceReference? = null

Reference to the source file or snippet of the diagnostic, if any

Link copied to clipboard
@JvmField
val renderedMessage: String? = null

Optionally contains a pre-formatted version of the message

Link copied to clipboard
@JvmField
val severity: Severity

Describes the severity of the diagnostic

Link copied to clipboard
@JvmField
val source: String? = null

Refers to the original processed source code

Link copied to clipboard
@JvmField
val span: SourceSpan? = null

Source span for the diagnostic, if any

Link copied to clipboard
@JvmField
val tool: String? = null

Functions

Link copied to clipboard