moonrockz/gleam-parser/diagnostic

README
U
Arg
U
ArgNames
U
Assert
U
AssignName
U
Assignment
U
AssignmentKind
U
BinOp
U
BitArrayOption
U
BitArraySegment
U
BitArraySize
U
CallArg
U
Clause
U
ClauseGuard
U
Comment
U
CommentKind
U
Constant
U
CustomType
U
DecodeError
U
Definition
U
DefinitionCst
U
DefinitionKind
U
Deprecation
U
Diagnostic
U
Dialect
U
Documentation
U
Expr
U
External
U
Function
U
FunctionLiteralKind
U
ImplicitCallArgOrigin
U
Import
U
ImportAlias
U
IncorrectNamePosition
U
IntOperator
U
Keyword
U
Label
U
LexicalErrorType
U
Module
U
ModuleConstant
U
ModuleCst
U
ModuleExtra
U
OracleOutput
U
ParseError
U
ParseErrorDetails
U
ParseErrorType
U
ParseResult
U
Parsed
U
Pattern
U
Position
U
Publicity
U
RecordBeingUpdated
U
RecordConstructor
U
RecordConstructorArg
U
RecordUpdateArg
U
Rule
U
Severity
U
SourceText
U
SpannedString
U
SrcSpan
U
Statement
U
StringPrefixLeftSideAssignment
U
TailPattern
U
Target
U
TargetedDefinition
U
TodoKind
U
Token
U
TokenKind
U
TokenStream
U
Trivia
U
TypeAlias
U
TypeAst
U
TypeAstConstructor
U
TypeAstConstructorName
U
TypeAstFn
U
TypeAstHole
U
TypeAstTuple
U
TypeAstVar
U
UnicodeEscapeError
U
UnqualifiedImport
U
Use
U
UseAssignment
U
Warning
V
canonical
V
decode_expr
V
decode_oracle_output
V
decode_parsed
V
diagnostic_description
V
encode_diagnostics
V
encode_expr
V
encode_oracle_output
V
encode_parsed
V
parse_float_value
V
parse_int_value
V
parse_module
V
parse_text
V
render_plain
V
render_terminal
V
tokenize
V
tokenize_text
V
version

moonrockz/gleam-parser/diagnostic does not have a README file

Diagnostic

pub(all) struct Diagnostic {
  code : String
  kind : String
  severity : Severity
  title : String
  message : String
  span : @moonrockz/gleam-parser/span.SrcSpan
SrcSpan
  labels : ArrayView[Label]
  text : String
  hint : String?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A problem found while scanning or parsing, in the Gleam compiler's shape: a title ("Syntax error"), a primary span with its message (the compiler's label text), extra labels, and an optional hint. code is one of codes().

Diagnostic::is_error

source

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

Diagnostic::new

source

fn Diagnostic::new(code~ : String, severity~ : Severity, title~ : String, message~ : String, span~ : @moonrockz/gleam-parser/span.SrcSpan
SrcSpan, kind? : String, labels? : Array[Label], text? : String, hint? : String?) -> Diagnostic

test {
  let d = @diagnostic.Diagnostic::new(
    code="GL-SCAN-001",
    severity=Error,
    title="Syntax error",
    message="I don't know what this character means",
    span=@span.SrcSpan::new(2, 3),
  )
  debug_inspect(d.is_error(), content="true")
  debug_inspect(d.labels.length(), content="0")
}

Label

source

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

A span with the text the compiler shows under it.

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::is_error

#Diagnostic::new

#Label

#Severity

#codes

#description

Source Files

Diagnostic

Diagnostic::is_error

Diagnostic::new

Label

Severity

codes

description