scala.util.parsing.combinator.Parsers.Parser

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

Parser
Function1
AnyRef
Any

Visibility

Public
All

Instance Constructors

new Parser ()

Abstract Value Members

def apply (in: Input): ParseResult[T]

An unspecified method that defines the behaviour of this parser.
An unspecified method that defines the behaviour of this parser.
returns
the result of function application.

Attributes
abstract
Definition Classes
Parser → Function1

Concrete Value Members

def != (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def != (arg0: Any): Boolean

Test two objects for inequality.
Test two objects for inequality.
returns
true if !(this == that), false otherwise.

Attributes
final
Definition Classes
Any
def ## (): Int

Equivalent to x.hashCode except for boxed numeric types.
Equivalent to x.hashCode except for boxed numeric types. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them.
returns
a hash value consistent with ==

Attributes
final
Definition Classes
AnyRef → Any
def * [U >: T] (sep: ⇒ Parser[(U, U) ⇒ U]): Parser[U]

Returns a parser that repeatedly parses what this parser parses, interleaved with the sep' parser. Thesep' parser specifies how the results parsed by this parser should be combined.
Returns a parser that repeatedly parses what this parser parses, interleaved with the sep' parser. Thesep' parser specifies how the results parsed by this parser should be combined.
returns
chainl1(this, sep)
def * : Parser[List[T]]

Returns a parser that repeatedly parses what this parser parses
Returns a parser that repeatedly parses what this parser parses
returns
rep(this)
def + : Parser[List[T]]

Returns a parser that repeatedly (at least once) parses what this parser parses.
Returns a parser that repeatedly (at least once) parses what this parser parses.
returns
rep1(this)
def <~ [U] (q: ⇒ Parser[U]): Parser[T]

A parser combinator for sequential composition which keeps only the left result
A parser combinator for sequential composition which keeps only the left result
p <~ q' succeeds if p' succeeds and q' succeeds on the input left over byp'.
Note: <~ has lower operator precedence than ~ or ~>.
q
a parser that will be executed after p' (this parser) succeeds -- evaluated at most once, and only when necessary
returns
a Parser' that -- on success -- returns the result of p'.

Annotations
@migration
Migration
"As of 2.9, the call-by-name argument is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing."
def == (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def == (arg0: Any): Boolean

Test two objects for equality.
Test two objects for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.

Attributes
final
Definition Classes
Any
def >> [U] (fq: (T) ⇒ Parser[U]): Parser[U]

Returns into(fq)
def ? : Parser[Option[T]]

Returns a parser that optionally parses what this parser parses.
Returns a parser that optionally parses what this parser parses.
returns
opt(this)
def ^? [U] (f: PartialFunction[T, U]): Parser[U]

A parser combinator for partial function application
A parser combinator for partial function application
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 (see mapPartial' in ParseResult').
returns
a parser that succeeds if the current parser succeeds and f' is applicable to the result. If so, the result will be transformed byf'.
def ^? [U] (f: PartialFunction[T, U], error: (T) ⇒ String): Parser[U]

A parser combinator for partial function application
A parser combinator for partial function application
p ^? (f, error)' 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'. If f' is not applicable, error(the result ofp') should explain why.
f
a partial function that will be applied to this parser's result (see mapPartial' in ParseResult').
error
a function that takes the same argument as f' and produces an error message to explain whyf' wasn't applicable
returns
a parser that succeeds if the current parser succeeds and f' is applicable to the result. If so, the result will be transformed byf'.
def ^^ [U] (f: (T) ⇒ U): Parser[U]

A parser combinator for function application
A parser combinator for function application
p ^^ f' succeeds if p' succeeds; it returns f' applied to the result of p'.
f
a function that will be applied to this parser's result (see map' in ParseResult').
returns
a parser that has the same behaviour as the current parser, but whose result is transformed by f'.
def ^^^ [U] (v: ⇒ U): Parser[U]

A parser combinator that changes a successful result into the specified value.
A parser combinator that changes a successful result into the specified value.
p ^^^ v' succeeds if p' succeeds; discards its result, and returns v instead.
v
The new result for the parser, evaluated at most once (if p succeeds), not evaluated at all if p fails.
returns
a parser that has the same behaviour as the current parser, but whose successful result is v

Annotations
@migration
Migration
"As of 2.9, the call-by-name argument is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing."
def andThen [A] (g: (ParseResult[T]) ⇒ A): (Input) ⇒ A

Composes two instances of Function1 in a new Function1, with this function applied first.
Composes two instances of Function1 in a new Function1, with this function applied first.
A
the result type of function g
g
a function R => A
returns
a new function f such that f(x) == g(apply(x))

Definition Classes
Function1
def append [U >: T] (p0: ⇒ Parser[U]): Parser[U]

Annotations
@migration
Migration
"As of 2.9, the call-by-name argument is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing."
def asInstanceOf [T0] : T0

Cast the receiver object to be of type T0.
Cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.
returns
the receiver object.

Attributes
final
Definition Classes
Any
def clone (): AnyRef

Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the clone method is platform dependent.
returns
a copy of the receiver object.

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def compose [A] (g: (A) ⇒ Input): (A) ⇒ ParseResult[T]

Composes two instances of Function1 in a new Function1, with this function applied last.
Composes two instances of Function1 in a new Function1, with this function applied last.
A
the type to which function g can be applied
g
a function A => T1
returns
a new function f such that f(x) == apply(g(x))

Definition Classes
Function1
def eq (arg0: AnyRef): Boolean

Tests whether the argument (arg0) is a reference to the receiver object (this).
Tests whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:
- It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
- For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
- null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
returns
true if the argument is a reference to the receiver object; false otherwise.

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

The equality method for reference types.
The equality method for reference types. See equals in Any.
returns
true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
AnyRef → Any
def finalize (): Unit

Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

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

A representation that corresponds to the dynamic class of the receiver object.
A representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
returns
a representation that corresponds to the dynamic class of the receiver object.

Attributes
final
Definition Classes
AnyRef → Any
def hashCode (): Int

The hashCode method for reference types.
The hashCode method for reference types. See hashCode in Any.
returns
the hash code value for this object.

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

A parser combinator that parameterizes a subsequent parser with the result of this one
A parser combinator that parameterizes a subsequent parser with the result of this one
Use this combinator when a parser depends on the result of a previous parser. p' should be a function that takes the result from the first parser and returns the second parser.p into fq' (with fq' typically {x => q}') first applies p', and then, if p' successfully returned result r', applies fq(r)' to the rest of the input.
From: G. Hutton. Higher-order functions for parsing. J. Funct. Program., 2(3):323--343, 1992.
fq
a function that, given the result from this parser, returns the second parser to be applied
returns
a parser that succeeds if this parser succeeds (with result x') and if then fq(x)' succeeds
def isInstanceOf [T0] : Boolean

Test whether the dynamic type of the receiver object is T0.
Test whether the dynamic type of the receiver object is T0.
Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.

Attributes
final
Definition Classes
Any
def map [U] (f: (T) ⇒ U): Parser[U]
def named (n: String): Parser.this.type
def ne (arg0: AnyRef): Boolean

Equivalent to !(this eq that).
Equivalent to !(this eq that).
returns
true if the argument is not a reference to the receiver object; false otherwise.

Attributes
final
Definition Classes
AnyRef
def notify (): Unit

Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.

Attributes
final
Definition Classes
AnyRef
def notifyAll (): Unit

Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.

Attributes
final
Definition Classes
AnyRef
def synchronized [T0] (arg0: ⇒ T0): T0

Attributes
final
Definition Classes
AnyRef
def toString (): String

Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
returns
a String representation of the object.

Definition Classes
Parser → Function1 → AnyRef → Any
def wait (): Unit

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

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

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
def | [U >: T] (q: ⇒ Parser[U]): Parser[U]

A parser combinator for alternative composition
A parser combinator for alternative composition
p | q' succeeds if p' succeeds or q' succeeds Note thatq' is only tried if p's failure is non-fatal (i.e., back-tracking is allowed).
q
a parser that will be executed if p' (this parser) fails (and allows back-tracking)
returns
a Parser' that returns the result of the first parser to succeed (out of p' and q') The resulting parser succeeds if (and only if) -p' succeeds, or
- if p' fails allowing back-tracking and q' succeeds.
def ||| [U >: T] (q0: ⇒ Parser[U]): Parser[U]

A parser combinator for alternative with longest match composition
A parser combinator for alternative with longest match composition
p ||| q' succeeds if p' succeeds or q' succeeds Ifp' and q' both succeed, the parser that consumed the most characters accepts.
q0
a parser that accepts if p consumes less characters. -- evaluated at most once, and only when necessary
returns
a Parser' that returns the result of the parser consuming the most characters (out of p' and q').

Annotations
@migration
Migration
"As of 2.9, the call-by-name argument is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing."
def ~ [U] (q: ⇒ Parser[U]): Parser[~[T, U]]

A parser combinator for sequential composition
A parser combinator for sequential composition
p ~ q' succeeds if p' succeeds and q' succeeds on the input left over byp'.
q
a parser that will be executed after p' (this parser) succeeds -- evaluated at most once, and only when necessary
returns
a Parser' that -- on success -- returns a ~' (like a Pair, but easier to pattern match on) that contains the result of p' and that of q'. The resulting parser fails if either p' or q' fails.

Annotations
@migration
Migration
"As of 2.9, the call-by-name argument is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing."
def ~! [U] (p: ⇒ Parser[U]): Parser[~[T, U]]

A parser combinator for non-back-tracking sequential composition
A parser combinator for non-back-tracking sequential composition
p ~! q' succeeds if p' succeeds and q' succeeds on the input left over byp'. In case of failure, no back-tracking is performed (in an earlier parser produced by the | combinator).
returns
a Parser' that -- on success -- returns a ~' (like a Pair, but easier to pattern match on) that contains the result of p' and that of q'. The resulting parser fails if either p' or q' fails, this failure is fatal.
def ~> [U] (q: ⇒ Parser[U]): Parser[U]

A parser combinator for sequential composition which keeps only the right result
A parser combinator for sequential composition which keeps only the right result
p ~> q' succeeds if p' succeeds and q' succeeds on the input left over byp'.
q
a parser that will be executed after p' (this parser) succeeds -- evaluated at most once, and only when necessary
returns
a Parser' that -- on success -- returns the result of q'.

Annotations
@migration
Migration
"As of 2.9, the call-by-name argument is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing."

Inherited from AnyRef

Value Members

def != (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def ## (): Int

Equivalent to x.hashCode except for boxed numeric types.
Equivalent to x.hashCode except for boxed numeric types. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them.
returns
a hash value consistent with ==

Attributes
final
Definition Classes
AnyRef → Any
def == (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def clone (): AnyRef

Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the clone method is platform dependent.
returns
a copy of the receiver object.

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

Tests whether the argument (arg0) is a reference to the receiver object (this).
Tests whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:
- It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
- For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
- null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
returns
true if the argument is a reference to the receiver object; false otherwise.

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

The equality method for reference types.
The equality method for reference types. See equals in Any.
returns
true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
AnyRef → Any
def finalize (): Unit

Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

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

A representation that corresponds to the dynamic class of the receiver object.
A representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
returns
a representation that corresponds to the dynamic class of the receiver object.

Attributes
final
Definition Classes
AnyRef → Any
def hashCode (): Int

The hashCode method for reference types.
The hashCode method for reference types. See hashCode in Any.
returns
the hash code value for this object.

Definition Classes
AnyRef → Any
def ne (arg0: AnyRef): Boolean

Equivalent to !(this eq that).
Equivalent to !(this eq that).
returns
true if the argument is not a reference to the receiver object; false otherwise.

Attributes
final
Definition Classes
AnyRef
def notify (): Unit

Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.

Attributes
final
Definition Classes
AnyRef
def notifyAll (): Unit

Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.

Attributes
final
Definition Classes
AnyRef
def synchronized [T0] (arg0: ⇒ T0): T0

Attributes
final
Definition Classes
AnyRef
def wait (): Unit

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

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

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()

Inherited from Any

Value Members

def != (arg0: Any): Boolean

Test two objects for inequality.
Test two objects for inequality.
returns
true if !(this == that), false otherwise.

Attributes
final
Definition Classes
Any
def == (arg0: Any): Boolean

Test two objects for equality.
Test two objects for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.

Attributes
final
Definition Classes
Any
def asInstanceOf [T0] : T0

Cast the receiver object to be of type T0.
Cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.
returns
the receiver object.

Attributes
final
Definition Classes
Any
def isInstanceOf [T0] : Boolean

Test whether the dynamic type of the receiver object is T0.
Test whether the dynamic type of the receiver object is T0.
Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.

Attributes
final
Definition Classes
Any

Parser

class Parser [+T] extends (Input) ⇒ ParseResult[T]

Instance Constructors

new Parser ()

Abstract Value Members

def apply (in: Input): ParseResult[T]

Concrete Value Members

def != (arg0: AnyRef): Boolean

def != (arg0: Any): Boolean

def ## (): Int

def * [U >: T] (sep: ⇒ Parser[(U, U) ⇒ U]): Parser[U]

def * : Parser[List[T]]

def + : Parser[List[T]]

def <~ [U] (q: ⇒ Parser[U]): Parser[T]

def == (arg0: AnyRef): Boolean

def == (arg0: Any): Boolean

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

def ? : Parser[Option[T]]

def ^? [U] (f: PartialFunction[T, U]): Parser[U]

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

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

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

def andThen [A] (g: (ParseResult[T]) ⇒ A): (Input) ⇒ A

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

def asInstanceOf [T0] : T0

def clone (): AnyRef

def compose [A] (g: (A) ⇒ Input): (A) ⇒ ParseResult[T]

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

def finalize (): Unit

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

def getClass (): java.lang.Class[_]

def hashCode (): Int

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

def isInstanceOf [T0] : Boolean

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

def named (n: String): Parser.this.type

def ne (arg0: AnyRef): Boolean

def notify (): Unit

def notifyAll (): Unit

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

def toString (): String

def wait (): Unit

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

def wait (arg0: Long): Unit

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

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

def ~ [U] (q: ⇒ Parser[U]): Parser[~[T, U]]

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

def ~> [U] (q: ⇒ Parser[U]): Parser[U]

Inherited from (Input) ⇒ ParseResult[T]

Value Members

def andThen [A] (g: (ParseResult[T]) ⇒ A): (Input) ⇒ A

def compose [A] (g: (A) ⇒ Input): (A) ⇒ ParseResult[T]

Inherited from AnyRef

Value Members

def != (arg0: AnyRef): Boolean

def ## (): Int

def == (arg0: AnyRef): Boolean

def clone (): AnyRef

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

def finalize (): Unit

def getClass (): java.lang.Class[_]

def hashCode (): Int

def ne (arg0: AnyRef): Boolean

def notify (): Unit

def notifyAll (): Unit

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

def wait (): Unit

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

def wait (arg0: Long): Unit

Inherited from Any

Value Members

def != (arg0: Any): Boolean

def == (arg0: Any): Boolean

def asInstanceOf [T0] : T0

def isInstanceOf [T0] : Boolean