LazyParsley

implicit final class LazyParsley[P, +A] extends AnyRef

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

LazyParsley
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new LazyParsley(p: => P)(implicit con: (P) => Parsley[A])

Value Members

def !(msggen: (A) => String): Parsley[Nothing]
Same as fail, except allows for a message generated from the result of the failed parser.
Same as fail, except allows for a message generated from the result of the failed parser. In essence, this is equivalent to p >>= (x => fail(msggen(x)) but requires no expensive computations from the use of >>=.
msggen
The generator function for error message, creating a message based on the result of invokee
returns
A parser that fails if it succeeds, with the given generator used to produce the error message
final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
def #>[B](x: B): Parsley[B]
This is the parser that corresponds to p *> pure(x) or a more optimal version of p.map(_ => x).
This is the parser that corresponds to p *> pure(x) or a more optimal version of p.map(_ => x). It performs the parse action of the invokee but discards its result and then results the value x instead
x
The value to be returned after the execution of the invokee
returns
A new parser which first parses the invokee, then results x
def *>[A_ >: A, B](q: => Parsley[B]): Parsley[B]
This is the parser that corresponds to a more optimal version of p.map(_ => x => x) <*> q.
This is the parser that corresponds to a more optimal version of p.map(_ => x => x) <*> q. It performs the parse action of both parsers, in order, but discards the result of the invokee.
q
The parser whose result should be returned
returns
A new parser which first parses p, then q and returns the result of q
def <#>[B](f: (A) => B): Parsley[B]
This combinator is an alias for map
def <*[B](q: => Parsley[B]): Parsley[A]
This is the parser that corresponds to a more optimal version of p.map(x => _ => x) <*> q.
This is the parser that corresponds to a more optimal version of p.map(x => _ => x) <*> q. It performs the parse action of both parsers, in order, but discards the result of the second parser.
q
The parser who should be executed but then discarded
returns
A new parser which first parses p, then q and returns the result of the p
def <**>[B](pf: => Parsley[(A) => B]): Parsley[B]
This combinator is defined as lift2((x, f) => f(x), p, f).
This combinator is defined as lift2((x, f) => f(x), p, f). It is pure syntactic sugar.
def <*>[B, C](px: => Parsley[B])(implicit ev: <:<[P, Parsley[(B) => C]]): Parsley[C]
This is the Applicative application parser.
This is the Applicative application parser. The type of pf is Parsley[A => B]. Then, given a Parsley[A], we can produce a Parsley[B] by parsing pf to retrieve f: A => B, then parse px to receive x: A then return f(x): B.
px
A parser of type A, where the invokee is A => B
returns
A new parser which parses pf, then px then applies the value returned by px to the function returned by pf
Note
pure(f) <*> p is subject to the same aggressive optimisations as map. When using impure functions the optimiser may decide to cache the result of the function execution, be sure to use unsafe in order to prevent these optimisations.
def <+:>[B >: A](ps: => Parsley[Seq[B]]): Parsley[Seq[B]]
This parser corresponds to lift2(_+:_, p, ps).
def </>[B >: A](x: B): Parsley[B]
This combinator is defined as p <|> pure(x).
This combinator is defined as p <|> pure(x). It is pure syntactic sugar.
def <::>[B >: A](ps: => Parsley[List[B]]): Parsley[List[B]]
This parser corresponds to lift2(_::_, p, ps).
def <\>[B >: A](q: Parsley[B]): Parsley[B]
This combinator is defined as attempt(p) <|> q.
This combinator is defined as attempt(p) <|> q. It is pure syntactic sugar.
def <|>[B >: A](q: => Parsley[B]): Parsley[B]
This is the traditional Alternative choice operator for parsers.
This is the traditional Alternative choice operator for parsers. Following the parsec semantics precisely, this combinator first tries to parse the invokee. If this is successful, no further action is taken. If the invokee failed *without* consuming input, then q is parsed instead. If the invokee did parse input then the whole parser fails. This is done to prevent space leaks and to give good error messages. If this behaviour is not desired, use the <\> combinator (or attempt(this) <|> q) to parse q regardless of how the invokee failed.
q
The parser to run if the invokee failed without consuming input
returns
The value produced by the invokee if it was successful, or if it failed without consuming input, the possible result of parsing q.
def <~[B](q: Parsley[B]): Parsley[A]
This is the parser that corresponds to a more optimal version of (p <~> q).map(_._1).
This is the parser that corresponds to a more optimal version of (p <~> q).map(_._1). It performs the parse action of both parsers, in order, but discards the result of the second parser.
q
The parser who should be executed but then discarded
returns
A new parser which first parses p, then q and returns the result of the p
Since
2.4.0
def <~>[A_ >: A, B](q: => Parsley[B]): Parsley[(A_, B)]
This parser corresponds to lift2((_, _), p, q).
This parser corresponds to lift2((_, _), p, q). For now it is sugar, but in future may be more optimal
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def >>[B](q: Parsley[B]): Parsley[B]
This combinator is an alias for *>
def >>=[B](f: (A) => Parsley[B]): Parsley[B]
This combinator is an alias for flatMap
def ?(msg: String): Parsley[A]
Alias for label
final def asInstanceOf[T0]: T0
Definition Classes
Any
def cast[B](implicit arg0: ClassTag[B]): Parsley[B]
This casts the result of the parser into a new type B.
This casts the result of the parser into a new type B. If the value returned by the parser is castable to type B, then this cast is performed. Otherwise the parser fails.
B
The type to attempt to cast into
Since
2.0.0
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def collect[B](pf: PartialFunction[A, B]): Parsley[B]
Attempts to first filter the parser to ensure that pf is defined over it.
Attempts to first filter the parser to ensure that pf is defined over it. If it is, then the function pf is mapped over its result. Roughly the same as a filter then a map.
pf
The partial function
returns
The result of applying pf to this parsers value (if possible), or fails
Since
2.0.0
def collectMsg[B](msggen: (A) => String)(pf: PartialFunction[A, B]): Parsley[B]
Attempts to first filter the parser to ensure that pf is defined over it.
Attempts to first filter the parser to ensure that pf is defined over it. If it is, then the function pf is mapped over its result. Roughly the same as a guard then a map.
msggen
Generator function for error message, generating a message based on the result of the parser
pf
The partial function
returns
The result of applying pf to this parsers value (if possible), or fails
Since
2.4.0
def collectMsg[B](msg: String)(pf: PartialFunction[A, B]): Parsley[B]
Attempts to first filter the parser to ensure that pf is defined over it.
Attempts to first filter the parser to ensure that pf is defined over it. If it is, then the function pf is mapped over its result. Roughly the same as a guard then a map.
msg
The message used for the error if the input failed the check
pf
The partial function
returns
The result of applying pf to this parsers value (if possible), or fails
Since
2.4.0
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def explain(reason: String): Parsley[A]
Similar to label, except instead of providing an expected message replacing the original tag, this combinator adds a reason that the error occurred.
Similar to label, except instead of providing an expected message replacing the original tag, this combinator adds a reason that the error occurred. This is in complement to the label. The reason is only added when the parser fails, and will disappear if any further progress in the parser is made (unlike labels, which may reappear as "hints").
reason
The reason why a parser failed
Since
2.7.0
def filter(pred: (A) => Boolean): Parsley[A]
Filter the value of a parser; if the value returned by the parser matches the predicate pred then the filter succeeded, otherwise the parser fails with an empty error
Filter the value of a parser; if the value returned by the parser matches the predicate pred then the filter succeeded, otherwise the parser fails with an empty error
pred
The predicate that is tested against the parser result
returns
The result of the invokee if it passes the predicate
def filterNot(pred: (A) => Boolean): Parsley[A]
Filter the value of a parser; if the value returned by the parser does not match the predicate pred then the filter succeeded, otherwise the parser fails with an empty error
Filter the value of a parser; if the value returned by the parser does not match the predicate pred then the filter succeeded, otherwise the parser fails with an empty error
pred
The predicate that is tested against the parser result
returns
The result of the invokee if it fails the predicate
def filterOut(pred: PartialFunction[A, String]): Parsley[A]
Filter the value of a parser; if the value returned by the parser is defined for the given partial function, then the filterOut fails, using the result of the function as the reason (see explain), otherwise the parser succeeds
Filter the value of a parser; if the value returned by the parser is defined for the given partial function, then the filterOut fails, using the result of the function as the reason (see explain), otherwise the parser succeeds
pred
The predicate that is tested against the parser result
returns
The result of the invokee if the value failed the predicate
Since
2.8.0
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
def flatMap[B](f: (A) => Parsley[B]): Parsley[B]
This is the traditional Monadic binding operator for parsers.
This is the traditional Monadic binding operator for parsers. When the invokee produces a value, the function f is used to produce a new parser that continued the computation.
f
A function that produces the next parser
returns
The parser produces from the application of f on the result of the last parser
Note
There is significant overhead for using flatMap; if possible try to write parsers in an applicative style otherwise try and use the intrinsic parsers provided to replace the flatMap.
def flatten[B](implicit ev: <:<[A, Parsley[B]]): Parsley[B]
This combinator is an alias for flatMap(identity).
def foldLeft[B](k: B)(f: (B, A) => B): Parsley[B]
A fold for a parser: p.foldLeft(k)(f) will try executing p many times until it fails, combining the results with left-associative application of f with a k on the left-most position
A fold for a parser: p.foldLeft(k)(f) will try executing p many times until it fails, combining the results with left-associative application of f with a k on the left-most position
k
base case for iteration
f
combining function
returns
the result of folding the results of p with f and k
Example:
1. val natural: Parsley[Int] = digit.foldLeft(0)((x, d) => x * 10 + d.toInt)
def foldLeft1[B](k: B)(f: (B, A) => B): Parsley[B]
A fold for a parser: p.foldLeft1(k)(f) will try executing p many times until it fails, combining the results with left-associative application of f with a k on the left-most position.
A fold for a parser: p.foldLeft1(k)(f) will try executing p many times until it fails, combining the results with left-associative application of f with a k on the left-most position. It must parse p at least once.
k
base case for iteration
f
combining function
returns
the result of folding the results of p with f and k
Example:
1. val natural: Parsley[Int] = digit.foldLeft1(0)((x, d) => x * 10 + d.toInt)
Since
2.1.0
def foldRight[B](k: B)(f: (A, B) => B): Parsley[B]
A fold for a parser: p.foldRight(k)(f) will try executing p many times until it fails, combining the results with right-associative application of f with a k at the right-most position
A fold for a parser: p.foldRight(k)(f) will try executing p many times until it fails, combining the results with right-associative application of f with a k at the right-most position
k
base case for iteration
f
combining function
returns
the result of folding the results of p with f and k
Example:
1. p.foldRight(Nil)(_::_) == many(p) //many is more efficient, however
def foldRight1[B](k: B)(f: (A, B) => B): Parsley[B]
A fold for a parser: p.foldRight1(k)(f) will try executing p many times until it fails, combining the results with right-associative application of f with a k at the right-most position.
A fold for a parser: p.foldRight1(k)(f) will try executing p many times until it fails, combining the results with right-associative application of f with a k at the right-most position. It must parse p at least once.
k
base case for iteration
f
combining function
returns
the result of folding the results of p with f and k
Example:
1. p.foldRight1(Nil)(_::_) == some(p) //some is more efficient, however
Since
2.1.0
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def getOrElse[B >: A](x: B): Parsley[B]
This combinator is an alias for </>.
def guard(pred: (A) => Boolean, msggen: (A) => String): Parsley[A]
Similar to filter, except the error message desired is also provided.
Similar to filter, except the error message desired is also provided. This allows you to name the message itself. The message is provided as a generator, which allows the user to avoid otherwise expensive computation.
pred
The predicate that is tested against the parser result
msggen
Generator function for error message, generating a message based on the result of the parser
returns
The result of the invokee if it passes the predicate
def guard(pred: (A) => Boolean, msg: String): Parsley[A]
Similar to filter, except the error message desired is also provided.
Similar to filter, except the error message desired is also provided. This allows you to name the message itself.
pred
The predicate that is tested against the parser result
msg
The message used for the error if the input failed the check
returns
The result of the invokee if it passes the predicate
def guardAgainst(pred: PartialFunction[A, String]): Parsley[A]
Similar to filterOut, except the error message generated yields a true failure.
Similar to filterOut, except the error message generated yields a true failure. This means that it will uses the same mechanism as Parsley.fail, as opposed to the reason provided by filterOut
pred
The predicate that is tested against the parser result and produces error messages
returns
The result of the invokee if it fails the predicate
Since
2.8.0
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
def hide: Parsley[A]
Hides the "expected" error message for a parser.
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def label(msg: String): Parsley[A]
Sets the expected message for a parser.
Sets the expected message for a parser. If the parser fails then expected msg will added to the error
Since
2.6.0
def map[B](f: (A) => B): Parsley[B]
This is the functorial map operation for parsers.
This is the functorial map operation for parsers. When the invokee produces a value, this value is fed through the function f.
f
The mutator to apply to the result of previous parse
returns
A new parser which parses the same input as the invokee but mutated by function f
Note
This is subject to aggressive optimisations assuming purity; the compiler is permitted to optimise such that the application of f actually only happens once at compile time. In order to preserve the behaviour of impure functions, consider using the unsafe method before map; p.unsafe.map(f).
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()
def orElse[B >: A](q: => Parsley[B]): Parsley[B]
This combinator is an alias for <|>.
def reduceLeft[B >: A](op: (B, A) => B): Parsley[B]
A reduction for a parser: p.reduceLeft(op) will try executing p many times until it fails, combining the results with left-associative application of op.
A reduction for a parser: p.reduceLeft(op) will try executing p many times until it fails, combining the results with left-associative application of op. It must parse p at least once.
op
combining function
returns
the result of reducing the results of p with op
Since
2.3.0
def reduceLeftOption[B >: A](op: (B, A) => B): Parsley[Option[B]]
A reduction for a parser: p.reduceLeft(op) will try executing p many times until it fails, combining the results with left-associative application of op.
A reduction for a parser: p.reduceLeft(op) will try executing p many times until it fails, combining the results with left-associative application of op. If there is no p, it returns None, otherwise it returns Some(x) where x is the result of the reduction.
op
combining function
returns
the result of reducing the results of p with op wrapped in Some or None otherwise
Since
2.3.0
def reduceRight[B >: A](op: (A, B) => B): Parsley[B]
A reduction for a parser: p.reduceRight(op) will try executing p many times until it fails, combining the results with right-associative application of op.
A reduction for a parser: p.reduceRight(op) will try executing p many times until it fails, combining the results with right-associative application of op. It must parse p at least once.
op
combining function
returns
the result of reducing the results of p with op
Since
2.3.0
def reduceRightOption[B >: A](op: (A, B) => B): Parsley[Option[B]]
A reduction for a parser: p.reduceRight(op) will try executing p many times until it fails, combining the results with right-associative application of op.
A reduction for a parser: p.reduceRight(op) will try executing p many times until it fails, combining the results with right-associative application of op. If there is no p, it returns None, otherwise it returns Some(x) where x is the result of the reduction.
op
combining function
returns
the result of reducing the results of p with op wrapped in Some or None otherwise
Since
2.3.0
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
def unexpected(msggen: (A) => String): Parsley[Nothing]
Same as unexpected, except allows for a message generated from the result of the failed parser.
Same as unexpected, except allows for a message generated from the result of the failed parser. In essence, this is equivalent to p >>= (x => unexpected(x)) but requires no expensive computations from the use of >>=
msggen
The generator function for error message, creating a message based on the result of invokee
returns
A parser that fails if it succeeds, with the given generator used to produce an unexpected message
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
def withFilter(pred: (A) => Boolean): Parsley[A]
def zip[A_ >: A, B](q: => Parsley[B]): Parsley[(A_, B)]
This combinator is an alias for <~>
This combinator is an alias for <~>
Since
2.3.0
def ~>[B](q: Parsley[B]): Parsley[B]
This is the parser that corresponds to a more optimal version of (p <~> q).map(_._2).
This is the parser that corresponds to a more optimal version of (p <~> q).map(_._2). It performs the parse action of both parsers, in order, but discards the result of the invokee.
q
The parser whose result should be returned
returns
A new parser which first parses p, then q and returns the result of q
Since
2.4.0

Deprecated Value Members

def >?>(pred: (A) => Boolean, msggen: (A) => String): Parsley[A]
Alias for guard combinator, taking a dynamic message generator.
Alias for guard combinator, taking a dynamic message generator.
Annotations
@deprecated
Deprecated
(Since version 2.8.0) This method will be removed in Parsley 3.0, use guard instead
def >?>(pred: (A) => Boolean, msg: String): Parsley[A]
Alias for guard combinator, taking a fixed message.
Alias for guard combinator, taking a fixed message.
Annotations
@deprecated
Deprecated
(Since version 2.8.0) This method will be removed in Parsley 3.0, use guard instead
def guardNot(pred: (A) => Boolean, msggen: (A) => String): Parsley[A]
Similar to filterNot, except the error message desired is also provided.
Similar to filterNot, except the error message desired is also provided. This allows you to name the message itself. The message is provided as a generator, which allows the user to avoid otherwise expensive computation.
pred
The predicate that is tested against the parser result
msggen
Generator function for error message, generating a message based on the result of the parser
returns
The result of the invokee if it fails the predicate
Annotations
@deprecated
Deprecated
(Since version 2.8.0) This method will be removed in Parsley 3.0, use guardAgainst instead
def guardNot(pred: (A) => Boolean, msg: String): Parsley[A]
Similar to filterNot, except the error message desired is also provided.
Similar to filterNot, except the error message desired is also provided. This allows you to name the message itself.
pred
The predicate that is tested against the parser result
msg
The message used for the error if the input failed the check
returns
The result of the invokee if it fails the predicate
Annotations
@deprecated
Deprecated
(Since version 2.8.0) This method will be removed in Parsley 3.0, use guardAgainst instead

Packages

Package structure

LazyParsley

implicit final class LazyParsley[P, +A] extends AnyRef

Instance Constructors

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Package structure

LazyParsley

implicit final class LazyParsley[P, +A] extends AnyRef

Instance Constructors

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

LazyParsley