Parser

Instance Constructors

new Parser()

Abstract Value Members

abstract def parse(in: ParserContext): Parsed[T]

Parses the string content in the specified context and returns the result.
Parses the string content in the specified context and returns the result.
This is the only abstract method in Parser that concrete implementations need to implement.

Concrete Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def *: Repeat[T]

Returns a parser that repeatedly applies this parser.
Returns a parser that repeatedly applies this parser. It will always succeed, potentially with an empty list as the result.
def +: Repeat[T]

Returns a parser that repeatedly applies this parser (at least once).
def <~[U](p: Parser[U]): Parser[T]

Applies the specified parser to the input left over by this parser, but only keeps the left result.
Applies the specified parser to the input left over by this parser, but only keeps the left result.
a <~ b only succeeds if both parsers succeed.
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def >>[U](fq: (T) ⇒ Parser[U]): Parser[U]

Operator synonym for flatMap.
def ?: Parser[Option[T]]

Returns a parser that optionally parses what this parser parses.
def ^?[U](f: PartialFunction[T, U], error: (T) ⇒ String = ...): Parser[U]

Returns a parser that applies a partial function to the result of this parser.
Returns a parser that applies a partial function to the result of this parser.
p ^? f succeeds if p succeeds and f is defined at the result of p, In that case it returns f applied to the result of p.
f
a partial function that will be applied to this parser's result.
error
an optional function that takes the same argument as f and produces an error message.
def ^^[U](f: (T) ⇒ U): Parser[U]

A synonym for map, allowing the grammar to be declared in a concise way.
def ^^?[U](f: (T) ⇒ Either[String, U]): Parser[U]

Returns a parser that applies a function to the result of this parser producing an Either where Left is interpreted as failure.
Returns a parser that applies a function to the result of this parser producing an Either where Left is interpreted as failure. It is an alternative to ^? for scenarios where the conditional check cannot be easily performed in a pattern match.
p ^^? f succeeds if p succeeds and f returns a Right when applied to the result of p.
def ^^^[U](v: ⇒ U): Parser[U]

Returns a parser that ignores the result of this parser (if it succeeds) and returns the specified result instead.
Returns a parser that ignores the result of this parser (if it succeeds) and returns the specified result instead.
Subclasses may override this method to avoid any expensive result processing.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flatMap[U](f: (T) ⇒ Parser[U]): Parser[U]

Builds a new parser by applying the specified function to the result of this parser and subsequently applying the parser returned by that function to the input left over by this parser.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
def map[U](f: (T) ⇒ U): Parser[U]

Builds a new parser by applying the specified function to the result of this parser.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def orElse[U >: T](p0: ⇒ Parser[U]): Parser[U]

Applies the specified parser when this parser fails.
Applies the specified parser when this parser fails.
a orElse b succeeds if either of the parsers succeeds.
Implementation note: The parameter is by-name to allow the definition of recursive parsers. In contrast to the former SDK parser combinators this is the only place where a parser with a by-name parameter is used whereas in all other places the additional cost is avoided.
def parse(in: String): Parsed[T]

Parses the specified string and returns the result.
def rep: Repeat[T]

Returns a parser that repeatedly applies this parser.
Returns a parser that repeatedly applies this parser. The returned parser offers an API to specify further constraints like min or max.
def repWith[U >: T](next: (U) ⇒ Parser[U]): Parser[List[U]]

Returns a parser that invokes the specified function repeatedly, passing the result of this parser if it succeeds, to produce new parsers that get applied until one of them fails.
Returns a parser that invokes the specified function repeatedly, passing the result of this parser if it succeeds, to produce new parsers that get applied until one of them fails.
The result of the returned parser is a list containing the result of this parser (if it succeeds) plus the results of successful invocations of the parsers returned by the specified function.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def withFailureMessage(msg: String): Parser[T]

Changes the failure message produced by a parser.
def |[U >: T](p: ⇒ Parser[U]): Parser[U]

Applies the specified parser when this parser fails.
Applies the specified parser when this parser fails.
a | b succeeds if either of the parsers succeeds.
Implementation note: The parameter is by-name to allow the definition of recursive parsers. In contrast to the former SDK parser combinators this is the only place where a parser with a by-name parameter is used whereas in all other places the additional cost is avoided.
def ~[U](p: Parser[U]): Parser[~[T, U]]

Applies the specified parser to the input left over by this parser and combines the two results.
Applies the specified parser to the input left over by this parser and combines the two results.
a ~ b only succeeds if both parsers succeed, with the results in a wrapper class named ~ for convenient pattern matching:
```
a ~ b ~ c ^^ {
  case a ~ b ~ c => processResult(a, b, c)
}
```
def ~>[U](p: Parser[U]): Parser[U]

Applies the specified parser to the input left over by this parser, but only keeps the right result.
Applies the specified parser to the input left over by this parser, but only keeps the right result.
a ~> b only succeeds if both parsers succeed.

Related Docs: object Parser | package parse

abstract class Parser[+T] extends AnyRef

Instance Constructors

new Parser()

Abstract Value Members

abstract def parse(in: ParserContext): Parsed[T]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def *: Repeat[T]

def +: Repeat[T]

def <~[U](p: Parser[U]): Parser[T]

final def ==(arg0: Any): Boolean

def >>[U](fq: (T) ⇒ Parser[U]): Parser[U]

def ?: Parser[Option[T]]

def ^?[U](f: PartialFunction[T, U], error: (T) ⇒ String = ...): Parser[U]

def ^^[U](f: (T) ⇒ U): Parser[U]

def ^^?[U](f: (T) ⇒ Either[String, U]): Parser[U]

def ^^^[U](v: ⇒ U): Parser[U]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def flatMap[U](f: (T) ⇒ Parser[U]): Parser[U]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def map[U](f: (T) ⇒ U): Parser[U]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def orElse[U >: T](p0: ⇒ Parser[U]): Parser[U]

def parse(in: String): Parsed[T]

def rep: Repeat[T]

def repWith[U >: T](next: (U) ⇒ Parser[U]): Parser[List[U]]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withFailureMessage(msg: String): Parser[T]

def |[U >: T](p: ⇒ Parser[U]): Parser[U]

def ~[U](p: Parser[U]): Parser[~[T, U]]

def ~>[U](p: Parser[U]): Parser[U]

Inherited from AnyRef

Inherited from Any

Ungrouped