Riddl
Primary Interface to Riddl Language parsing and validating
Attributes
- Source
- Riddl.scala
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
Riddl.type
Members list
Value members
Concrete methods
Parse an input with options and return the result
Parse an input with options and return the result
Value parameters
- commonOptions
-
The com.ossuminc.riddl.language.CommonOptions to use during the parsing
- input
-
The com.ossuminc.riddl.language.parsing.RiddlParserInput to use as the input of the parsing
Attributes
- Returns
- Source
- Riddl.scala
Parse and validate some com.ossuminc.riddl.language.parsing.RiddlParserInput
Parse and validate some com.ossuminc.riddl.language.parsing.RiddlParserInput
Value parameters
- commonOptions
-
The com.ossuminc.riddl.language.CommonOptions to use during parsing and validation
- input
-
The com.ossuminc.riddl.language.parsing.RiddlParserInput to use as the input to the parser
- logger
-
The logger to which messages should be logged
- passes
-
The set of passes to be run after parsing. It defaults to the standard passes: symbols, reference resolution, validation
- shouldFailOnError
-
If set to true if the parsing succeeds and the validation generates errors in which case the errors will simply be returned, otherwise the PassesResult will be returned.
Attributes
- Returns
- Source
- Riddl.scala
Same as Riddl.parseAndValidate but with a Java Path as the input instead
Same as Riddl.parseAndValidate but with a Java Path as the input instead
Attributes
- Source
- Riddl.scala
Run the standard passes after parsing
Run the standard passes after parsing
Value parameters
- options
-
The common options to use for the validation
- root
-
The root object of the model which is the product of parsing
- shouldFailOnError
-
Whether this should just return the Left[Messages] if an error occurs in them, or not
Attributes
- Returns
- Source
- Riddl.scala