RIDDL API Documentation
0.0.0-1-403b318f
API
Generated with
Copyright 2019 Ossum, Inc.. All Rights Reserved.
Copyright 2019 Ossum, Inc.. All Rights Reserved.
RIDDL API Documentation/com.ossuminc.riddl/com.ossuminc.riddl.language/com.ossuminc.riddl.language.parsing/EmptyParserInput

EmptyParserInput

com.ossuminc.riddl.language.parsing.EmptyParserInput
case object EmptyParserInput extends RiddlParserInput

Attributes

Source
RiddlParserInput.scala
Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class ParserInput
trait IsReachable
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Inherited types

type MirroredElemLabels = EmptyTuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Singleton
Source
Mirror.scala
type MirroredElemTypes = EmptyTuple

Attributes

Inherited from:
Singleton
Source
Mirror.scala
type MirroredMonoType = Singleton.this.type

The mirrored *-type

The mirrored *-type

Attributes

Inherited from:
Singleton
Source
Mirror.scala
type MirroredType = Singleton.this.type

Attributes

Inherited from:
Singleton
Source
Mirror.scala

Inherited and Abstract types

type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
Source
Mirror.scala

Value members

Concrete methods

def data: String

The data that will be parsed by fastparse

The data that will be parsed by fastparse

Attributes

Source
RiddlParserInput.scala
def from: String

Attributes

Source
RiddlParserInput.scala
override def lineOf(offset: Int): Int

Attributes

Definition Classes
Source
RiddlParserInput.scala
override def offsetOf(line: Int): Int

Attributes

Definition Classes
Source
RiddlParserInput.scala
override def origin: String

The short origin name to use in error messages as the origin of the error.

The short origin name to use in error messages as the origin of the error. In test cases that do not use a URL, this should be overridden with the word "empty"

Attributes

Returns

Typically the last filename in the URL is sufficient, and that is the default calculated from root.

Definition Classes
Source
RiddlParserInput.scala
override def root: URL

The URL from which the data originated.

The URL from which the data originated. If it didn't originate from a network or file location, then this should be empty, URL("") so that URL validity checking will be skipped.

Attributes

Definition Classes
Source
RiddlParserInput.scala

Inherited methods

def annotateErrorLine(index: At): String

Attributes

Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
inline override def apply(index: Int): Char

Attributes

Definition Classes
RiddlParserInput -> ParserInput -> IsReachable
Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
final def at(start: Int, end: Int): At

Attributes

Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
def checkTraceable(): Unit

Attributes

Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
inline override def dropBuffer(index: Int): Unit

Special method for Iterator mode.

Special method for Iterator mode. It drops the prefix of the internal buffer so that all the data strictly before becomes unavailable and index is the first valid element to access.

Attributes

Definition Classes
RiddlParserInput -> ParserInput
Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
def fromProduct(p: Product): MirroredMonoType

Create a new instance of type T with elements taken from product p.

Create a new instance of type T with elements taken from product p.

Attributes

Inherited from:
Singleton
Source
Mirror.scala
inline override def innerLength: Int

Attributes

Definition Classes
RiddlParserInput -> ParserInput
Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
final inline def isEmpty: Boolean

Attributes

Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
inline override def isReachable(index: Int): Boolean

Shows if we can access to the element at given index.

Shows if we can access to the element at given index.

Attributes

Definition Classes
RiddlParserInput -> ParserInput -> IsReachable
Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
inline override def length: Int

Attributes

Definition Classes
RiddlParserInput -> ParserInput
Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
def lineRangeOf(loc: At): (Int, Int)

Attributes

Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
final def location(index: Int): At

Attributes

Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
final inline def nonEmpty: Boolean

Attributes

Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
def prettyIndex(index: Int): String

Attributes

Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def purpose: String

The purpose of this parsing input.

The purpose of this parsing input. It could be a test name or blank for normal usage

Attributes

Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
def rangeOf(index: Int): (Int, Int)

Attributes

Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
inline override def slice(from: Int, until: Int): String

Attributes

Returns

Slice of internal data. For IndexedSeq mode it works as regular slice, if until overshoots the end of input, it just ignores it and behaves like until equals to the length of input. Same for Iterator mode, but it requests batches while the index of last retrieved element is less than until and if until is farther away than any element, it ignores this too.

Definition Classes
RiddlParserInput -> ParserInput
Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala

Inherited fields

val nl: String

Attributes

Inherited from:
RiddlParserInput
Source
RiddlParserInput.scala
Generated with
Copyright 2019 Ossum, Inc.. All Rights Reserved.
Copyright 2019 Ossum, Inc.. All Rights Reserved.