README
U
AggregateType
U
ApplyStatement
U
Column
U
Comment
U
CommentKind
U
Control
U
ControlStatement
U
Depth
U
Diagnostic
U
DocComment
U
EnterEvent
U
EntityType
U
EnumMember
U
EnumType
U
Event
U
EventReader
U
EventSource
U
Handler
U
IdlCst
U
IdlFile
U
InlineShape
U
Keyword
U
Label
U
LeaveEvent
U
Length
U
Line
U
Member
U
MemberTarget
U
MetadataStatement
U
Mixins
U
NamespaceStatement
U
Node
U
NodeKvp
U
NodePath
U
NodeRef
U
NodeValue
U
NumberLiteral
U
NumberValue
U
Offset
U
OperationProperty
U
OperationTarget
U
ParseError
U
ParseResult
U
PathStep
U
Piece
U
Position
U
Severity
U
Shape
U
ShapeId
U
ShapeKind
U
ShapeStatement
U
SimpleType
U
SourceText
U
Span
U
Statement
U
StatementCst
U
StatementKind
U
Step
U
Token
U
TokenKind
U
TokenStream
U
Trait
U
TraitBody
U
Tree
U
TreeCursor
U
Trivia
U
UseStatement
U
Version
U
Visitor
V
accept
V
diagnostic_description
V
fold
V
kind_table
V
parse
V
parse_idl
V
push_events
V
reduce
V
reduce_pruned
V
render_all
V
render_plain
V
render_short
V
render_terminal
V
render_terminal_to
V
tokenize
V
version
V
walk

#diagnostic

A Diagnostic is a code (SM-SCAN-nnn, SM-PARSE-nnn), a severity, a title, a message under its primary span, secondary labels, notes, and an optional hint and example. It is a value: with_context returns a copy. codes() lists every code.

///|
test {
  debug_inspect(
    @diagnostic.description("SM-PARSE-003"),
    content="Some(\"Missing line break between statements\")",
  )
}

Diagnostic

source

pub(all) struct Diagnostic {
  code : String
  severity : Severity
  title : String
  message : String
  span : @moonrockz/smithy-syntax/span.Span
Span
  labels : ArrayView[Label]
  notes : ArrayView[String]
  hint : String?
  example : String?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A problem found while scanning or parsing, with everything a rich report needs: a title in capitals (UNFINISHED SHAPE), a one-line message under the primary span, secondary labels, notes in the first person, an optional hint and an optional correct example. Immutable: with_context returns a new value.

Diagnostic::is_error

source

fn Diagnostic::is_error(self : Diagnostic) -> Bool

Whether the severity is Error.

Diagnostic::new

source

fn Diagnostic::new(code~ : String, severity~ : Severity, title~ : String, message~ : String, span~ : @moonrockz/smithy-syntax/span.Span
Span, labels? : Array[Label], notes? : Array[String], hint? : String, example? : String) -> Diagnostic

Build a diagnostic; the optional parts default to empty lists and None.

Diagnostic::with_context

source

fn Diagnostic::with_context(self : Diagnostic, label : Label, note : String) -> Diagnostic

A copy with label as the first label and note as the first note.

Label

source

pub(all) struct Label {
  span : @moonrockz/smithy-syntax/span.Span
Span
  text : String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A secondary span with the text shown under it ("the structure started here").

Severity

source

pub(all) enum Severity {
  Error
  Warning
} derive(Eq, Hash, @moonbitlang/core/debug.Debug
Debug)

How serious a diagnostic is. A file with an Error is rejected; a Warning does not stop parsing.

codes

source

fn codes() -> ArrayView[String]

Every diagnostic code, in table order.

description

source

fn description(code : String) -> String?

The one-line description of a code, or None for an unknown code.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#diagnostic

#Diagnostic

#Diagnostic::is_error

#Diagnostic::new

#Diagnostic::with_context

#Label

#Severity

#codes

#description

Source Files

Diagnostic

Diagnostic::is_error

Diagnostic::new

Diagnostic::with_context

Label

Severity

codes

description