engine/elide.runtime.diag/MutableDiagnostic

MutableDiagnostic

class MutableDiagnostic : MutableDiagnosticInfo

Mutable Diagnostic

Describes a class which carries fully mutable diagnostic information; this class is also made available reflectively for spawning new diagnostics from native contexts.

Diagnostics should always be finalized into a Diagnostic instance to enforce immutability and thread-safety.

Types

Companion

object Companion

Properties

advice

open override var advice: String?

Optional corrective action to take, if any

open override var id: String?

ID or class for this diagnostic type, if supported.

lang

open override var lang: String?

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

message

open override var message: String?

Message associated with the diagnostic

position

open override var position: SourceLocation?

Position in the source for the diagnostic, if any

reference

open override var reference: SourceReference?

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

renderedMessage

open override var renderedMessage: String?

Optionally contains a pre-formatted version of the message

severity

open override var severity: Severity

Describes the severity of the diagnostic

source

open override var source: String?

Refers to the original processed source code

span

open override var span: SourceSpan?

Source span for the diagnostic, if any

tool

open override var tool: String?

Name of the tool that generated the diagnostic, if known.

Functions

build

fun build(): Diagnostic

Build this mutable diagnostic into a finalized immutable record.

setSeverity

@JvmName(name = "setSeverity")

fun setSeverity(int: Int): MutableDiagnostic

Set the severity level using the native ordinal integer representing a given enumerated value.

MutableDiagnostic