Primary interface to setting up a RIDDL Parser's input. The idea here is to use one of the apply methods in this companion object to construct a RiddlParserInput for a specific input source (file, path, Source, data string, URL, etc.)
Attributes
- Companion
- class
- Source
- RiddlParserInput.scala
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
RiddlParserInput.type
Members list
Value members
Concrete methods
Set up a parser input for parsing directly from a local file based on the current working directory
Set up a parser input for parsing directly from a local file based on the current working directory
Value parameters
- path
-
The path that will be added to the current working directory
Attributes
- Source
- RiddlParserInput.scala
Attributes
- Source
- RiddlParserInput.scala
Attributes
- Source
- RiddlParserInput.scala
Set up a parser input for parsing directly from a file at a specific Path
Set up a parser input for parsing directly from a file at a specific Path
Value parameters
- basis
-
The path basis for subsequent include statements. Think of this as the root path from which all includes will be derived
- path
-
The java.nio.path.Path from which UTF-8 text will be read and parsed as the first file
- purpose
-
. The description string of the purpose of the constructed URL
Attributes
- Note
-
JVM Only
- Source
- RiddlParserInput.scala
Set up a parser input from a com.ossuminc.riddl.utils.URL.
Set up a parser input from a com.ossuminc.riddl.utils.URL.
Value parameters
- url
-
The url from which to load the data
Attributes
- Returns
-
A Future[RiddlParserInput] with the RPI set up to load data from the provided url
- Source
- RiddlParserInput.scala
Concrete fields
Attributes
- Source
- RiddlParserInput.scala
Implicits
Implicits
Set up a parser input for parsing directly from a String
Set up a parser input for parsing directly from a String
Value parameters
- data
-
data The UTF-8 string to be parsed
- purpose
-
The purpose for which this data is provided, often the test case name
- root
-
The URL from which the input data was derived
Attributes
- Source
- RiddlParserInput.scala
Set up a parser input for parsing a test case from a String and the testCaseName.
Set up a parser input for parsing a test case from a String and the testCaseName.
Value parameters
- data
-
The data to be parsed and returned in a RiddlParserInput
- purpose
-
A string, typically derived by the scalatest TestData extension in ParserTest.
Attributes
- Source
- RiddlParserInput.scala
Attributes
- Source
- RiddlParserInput.scala