sealed trait RichParser[A] extends AnyRef
- Alphabetic
- By Inheritance
- RichParser
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
!!!(msg: String): Parser[A]
Uses the specified message if the original Parser fails.
-
abstract
def
&(o: Parser[_]): Parser[A]
Apply the original parser, but only succeed if
o
also succeeds.Apply the original parser, but only succeed if
o
also succeeds. Note thato
does not need to consume the same amount of input to satisfy this condition. -
abstract
def
*: Parser[Seq[A]]
Apply the original Parser zero or more times and provide the (potentially empty) sequence of results.
-
abstract
def
+: Parser[Seq[A]]
Apply the original Parser one or more times and provide the non-empty sequence of results.
-
abstract
def
<~[B](b: Parser[B]): Parser[A]
Produces a Parser that applies the original Parser and then applies
next
(in order), discarding the result ofnext
.Produces a Parser that applies the original Parser and then applies
next
(in order), discarding the result ofnext
. (The arrow point in the direction of the retained result.) -
abstract
def
?: Parser[Option[A]]
Apply the original Parser zero or one times, returning None if it was applied zero times or the result wrapped in Some if it was applied once.
-
abstract
def
??[B >: A](alt: B): Parser[B]
Apply the original Parser, but provide
alt
as the result if it fails. -
abstract
def
^^^[B](value: B): Parser[B]
Apply the original Parser, but provide
value
as the result if it succeeds. -
abstract
def
examples(exampleSource: ExampleSource, maxNumberOfExamples: Int, removeInvalidExamples: Boolean): Parser[A]
- exampleSource
the source of examples when displaying completions to the user.
- maxNumberOfExamples
limits the number of examples that the source of examples should return. This can prevent lengthy pauses and avoids bad interactive user experience.
- removeInvalidExamples
indicates whether completion examples should be checked for validity (against the given parser). Invalid examples will be filtered out and only valid suggestions will be displayed.
- returns
a new parser with a new source of completions.
-
abstract
def
examples(s: Set[String], check: Boolean = false): Parser[A]
Explicitly defines the completions for the original Parser.
-
abstract
def
examples(s: String*): Parser[A]
Explicitly defines the completions for the original Parser.
-
abstract
def
failOnException: Parser[A]
If an exception is thrown by the original Parser, capture it and fail locally instead of allowing the exception to propagate up and terminate parsing.
-
abstract
def
filter(f: (A) ⇒ Boolean, msg: (String) ⇒ String): Parser[A]
Produces a Parser that filters the original parser.
Produces a Parser that filters the original parser. If 'f' is not true when applied to the output of the original parser, the Parser returned by this method fails. The failure message is constructed by applying
msg
to the String that was successfully parsed by the original parser. -
abstract
def
flatMap[B](f: (A) ⇒ Parser[B]): Parser[B]
Applies the original parser, applies
f
to the result to get the next parser, and applies that parser and uses its result for the overall result. -
abstract
def
id: Parser[A]
Returns the original parser.
Returns the original parser. This is useful for converting literals to Parsers. For example,
'c'.id
or"asdf".id
-
abstract
def
map[B](f: (A) ⇒ B): Parser[B]
Apply the original Parser to the input and then apply
f
to the result. -
abstract
def
string(implicit ev: <:<[A, Seq[Char]]): Parser[String]
Converts a Parser returning a Char sequence to a Parser returning a String.
-
abstract
def
|[B >: A](b: Parser[B]): Parser[B]
Apply either the original Parser or
b
. -
abstract
def
||[B](b: Parser[B]): Parser[Either[A, B]]
Apply either the original Parser or
b
. -
abstract
def
~[B](next: Parser[B]): Parser[(A, B)]
Apply the original Parser and then apply
next
(in order).Apply the original Parser and then apply
next
(in order). The result of both is provides as a pair. -
abstract
def
~>[B](b: Parser[B]): Parser[B]
Produces a Parser that applies the original Parser and then applies
next
(in order), discarding the result of the original parser.Produces a Parser that applies the original Parser and then applies
next
(in order), discarding the result of the original parser. (The arrow point in the direction of the retained result.)
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
examples(exampleSource: ExampleSource): Parser[A]
- exampleSource
the source of examples when displaying completions to the user.
- returns
a new parser with a new source of completions. It displays at most 25 completion examples and does not remove invalid examples.
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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( ... ) @native()