Class

scala.meta.internal.fastparse.parsers.Terminals

Start

Related Doc: package Terminals

Permalink

case class Start[Elem, Repr]()(implicit repr: ReprOps[Elem, Repr]) extends Parser[Unit, Elem, Repr] with Product with Serializable

Succeeds if at the start of the input, consuming no input

Linear Supertypes
Serializable, java.io.Serializable, Product, Equals, Parser[Unit, Elem, Repr], Precedence, ParserResults[Unit, Elem, Repr], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Start
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Parser
  7. Precedence
  8. ParserResults
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Start()(implicit repr: ReprOps[Elem, Repr])

    Permalink

Type Members

  1. type InstrumentCallback = (Parser[_, Elem, Repr], Int, () ⇒ Parsed[_, Elem, Repr]) ⇒ Unit

    Permalink

    Can be passed into a .parse call to let you inject logic around the parsing of top-level parsers, e.g.

    Can be passed into a .parse call to let you inject logic around the parsing of top-level parsers, e.g. for logging and debugging.

    Definition Classes
    Parser

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def fail(f: Failure[Elem, Repr], index: Int, traceParsers: Set[Parser[_, Elem, Repr]] = null, cut: Boolean = false): Failure[Elem, Repr]

    Permalink

    Prepares a failure object for a new failure

    Prepares a failure object for a new failure

    f

    The failure object, usually retrieved from the ParseCtx to avoid allocation overhead

    index

    The index at which this failure occurred

    traceParsers

    Any parsers which failed at the current index. These get noted in the error message if traceFailure is set. By default, this is the current parser.

    cut

    Whether or not this failure should prevent backtracking

    Definition Classes
    ParserResults
  8. def failMore(f: Failure[Elem, Repr], index: Int, logDepth: Int, traceParsers: Set[Parser[_, Elem, Repr]] = null, cut: Boolean = false): Failure[Elem, Repr]

    Permalink

    Prepares a failure object to continue an existing failure, e.g.

    Prepares a failure object to continue an existing failure, e.g. if some sub-parser failed and you want to pass the failure up the stack.

    f

    The failure returned by the subparser

    index

    The index of the *current* parser

    traceParsers

    Any parsers which failed at the current index. These get noted in the error message if traceFailure is set. By default, the existing traceParsers from the original failure are left unchanged

    cut

    Whether or not this parser failing should prevent backtracking. ORed with any cuts caused by the existing failure

    Definition Classes
    ParserResults
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. def mergeTrace(traceIndex: Int, lhs: Set[Parser[_, Elem, Repr]], rhs: Set[Parser[_, Elem, Repr]]): Set[Parser[_, Elem, Repr]]

    Permalink
    Definition Classes
    ParserResults
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. def opPred: Int

    Permalink

    Whether or not to surround this parser with parentheses when printing.

    Whether or not to surround this parser with parentheses when printing. By default a top-level parser is always left without parentheses, but if a sub-parser is embedded inside with lower precedence, it will be surrounded. Set to Integer.MaxValue to never be parenthesized

    Definition Classes
    ParserPrecedence
  17. def opWrap(s: Precedence): String

    Permalink
    Attributes
    protected
    Definition Classes
    Precedence
  18. def parse(input: Repr, index: Int = 0, instrument: InstrumentCallback = null): Parsed[Unit, Elem, Repr]

    Permalink

    Parses the given input starting from the given index

    Parses the given input starting from the given index

    input

    The string we want to parse

    index

    The index in the string to start from. By default parsing starts from the beginning of a string, but you can start from halfway through the string if you want.

    instrument

    Allows you to pass in a callback that will get called by every named rule, its index, as it itself given a callback that can be used to recurse into the parse and return the result. Very useful for extracting auxiliary information from the parse, e.g. counting rule invocations to locate bottlenecks or unwanted backtracking in the parser.

    Definition Classes
    Parser
  19. def parseInput(input: ParserInput[Elem, Repr], index: Int = 0, instrument: InstrumentCallback = null): Parsed[Unit, Elem, Repr]

    Permalink
    Definition Classes
    Parser
  20. def parseIterator(input: Iterator[Repr], index: Int = 0, instrument: InstrumentCallback = null)(implicit ct: ClassTag[Elem]): Parsed[Unit, Elem, Repr]

    Permalink
    Definition Classes
    Parser
  21. def parseRec(cfg: ParseCtx[Elem, Repr], index: Int): core.Mutable[Unit, Elem, Repr]

    Permalink

    Parses the given input starting from the given index and logDepth

    Parses the given input starting from the given index and logDepth

    Definition Classes
    StartParser
  22. implicit val reprOps: ReprOps[Elem, Repr]

    Permalink
    Definition Classes
    Parser
  23. def shortTraced: Boolean

    Permalink

    Whether or not this parser should show up when Parsed.TracedFailure.trace is called.

    Whether or not this parser should show up when Parsed.TracedFailure.trace is called. If not set, the parser will only show up in Parsed.TracedFailure.fullStack

    Definition Classes
    Parser
  24. def success[T](s: Success[_, Elem, Repr], value: T, index: Int, traceParsers: Set[Parser[_, Elem, Repr]], cut: Boolean): Success[T, Elem, Repr]

    Permalink

    Prepares a success object to be returned.

    Prepares a success object to be returned.

    s

    The existing success object, usually taken from ParseCtx to avoid allocation overhead.

    value

    The value that this parser succeeded with

    index

    The index of the parser *after* having successfully parsed part of the input

    traceParsers

    Any parsers which failed at the current index in the creation of this success. Even though this parser succeeded, failures inside sub-parsers must be reported to ensure proper error reporting.

    cut

    Whether the parse crossed a cut and should prevent backtracking

    Definition Classes
    ParserResults
  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  26. val toString: String

    Permalink
    Definition Classes
    Start → AnyRef → Any
  27. def unapply(input: Repr): Option[Unit]

    Permalink

    Extractor for pattern matching

    Extractor for pattern matching

    For example:

    val p1 = CharIn('a'to'z').! ~ CharIn('0'to'9').rep(1).!.map(_.toInt)
    List("a42x") match {
      case p1(x: String, y: Int) :: _ => // x is "a", y is 42
    }
    Definition Classes
    Parser
  28. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from Product

Inherited from Equals

Inherited from Parser[Unit, Elem, Repr]

Inherited from Precedence

Inherited from ParserResults[Unit, Elem, Repr]

Inherited from AnyRef

Inherited from Any

Ungrouped