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

#parser

parse_text parses Smithy IDL into a ParseResult: the AST (ast), the CST (cst, lossless), the declared version and the diagnostics. An error inside a statement is reported once and the parser resumes at the next statement.

///|
test {
  let r = @parser.parse_text(
    "$version: \"2\"\nnamespace com.foo\n\nstring Name\n",
  )
  inspect(r.has_errors(), content="false")
  guard r.ast is Some(f) else { fail("no ast") }
  inspect(f.shapes()[0].shape.name().value, content="Name")
}

ParseError

source

pub(all) suberror ParseError {
  ParseError(@moonrockz/smithy-syntax/diagnostic.Diagnostic
Diagnostic)
} derive(@moonbitlang/core/debug.Debug
Debug)

A syntax error, carrying its finished diagnostic. Raised inside a statement; parse catches it, records it and recovers.

ParseError::diagnostic

source

fn ParseError::diagnostic(self : ParseError) -> @moonrockz/smithy-syntax/diagnostic.Diagnostic
Diagnostic

The diagnostic the error carries.

Depth

source

pub struct Depth(Int) derive(Compare, Eq, @moonbitlang/core/debug.Debug
Debug)

A nesting count of node values, member blocks and trait bodies.

Depth::deeper

source

fn Depth::deeper(self : Depth) -> Depth

One level deeper.

Depth::shallower

source

fn Depth::shallower(self : Depth) -> Depth

One level shallower; never goes below zero.

Depth::zero

source

fn Depth::zero() -> Depth

The shallowest depth: not nested at all.

ParseResult

source

pub(all) struct ParseResult {
  ast : @moonrockz/smithy-syntax/ast.IdlFile
IdlFile?
  cst : @moonrockz/smithy-syntax/cst.IdlCst
IdlCst
  version : Version?
  diagnostics : ArrayView[@moonrockz/smithy-syntax/diagnostic.Diagnostic
Diagnostic]
} derive(@moonbitlang/core/debug.Debug
Debug)

What parse returns. ast is the (possibly partial) tree whenever at least one statement parsed, and an empty IdlFile (with an empty span) for a file with no tokens (empty or only comments); it is None only when the file has tokens and every statement failed. cst has every token. version is the declared $version, None when absent.

ParseResult::errors

source

fn ParseResult::errors(self : ParseResult) -> Array[@moonrockz/smithy-syntax/diagnostic.Diagnostic
Diagnostic]

Only the diagnostics that are errors.

ParseResult::has_errors

source

fn ParseResult::has_errors(self : ParseResult) -> Bool

Whether any diagnostic is an error (not just a warning).

Version

source

pub(all) enum Version {
  V1
  V2
} derive(Eq, Hash, @moonbitlang/core/debug.Debug
Debug)

The IDL version a file declares with $version.

Version::of

source

fn Version::of(text : String) -> Version?

1, 1.0, 2, 2.0, else None.

max_nesting

source

let max_nesting : Depth

Deepest nesting the parser enters; deeper text is SM-PARSE-010, never a stack overflow.

parse

source

fn parse(source : @moonrockz/smithy-syntax/span.SourceText
SourceText) -> ParseResult

Parse Smithy IDL source text: a pipeline of the pure scanner and the parser.

parse_text

source

fn parse_text(text : String) -> ParseResult

parse of a SourceText built from text.

parse_tokens

source

fn parse_tokens(stream : @moonrockz/smithy-syntax/scanner.TokenStream
TokenStream) -> ParseResult

Parse a token stream into an IdlFile, with recovery per statement.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#parser

#ParseError

#ParseError::diagnostic

#Depth

#Depth::deeper

#Depth::shallower

#Depth::zero

#ParseResult

#ParseResult::errors

#ParseResult::has_errors

#Version

#Version::of

#max_nesting

#parse

#parse_text

#parse_tokens

Source Files

ParseError

ParseError::diagnostic

Depth

Depth::deeper

Depth::shallower

Depth::zero

ParseResult

ParseResult::errors

ParseResult::has_errors

Version

Version::of

max_nesting

parse

parse_text

parse_tokens