parsley/parsley/Parsley

Parsley

final class Parsley[+A] extends AnyVal

This is the class that encapsulates the act of parsing and running an object of this class with parse will parse the string given as input to parse.

This is the class that encapsulates the act of parsing and running an object of this class with parse will parse the string given as input to parse.

Note: In order to construct an object of this class you must use the combinators; the class itself is abstract

Authors

Jamie Willis

Version

1

Companion
object
class AnyVal
trait Matchable
class Any

Value members

Concrete methods

def force(): Unit

Forces the compilation of a parser as opposed to the regular lazy evaluation.

Forces the compilation of a parser as opposed to the regular lazy evaluation.

def overflows(): Unit

Provides an indicator that this parser is likely to stack-overflow

Provides an indicator that this parser is likely to stack-overflow

def parse[Err](input: String)(`evidence$1`: ErrorBuilder[Err]): Result[Err, A]

This method is responsible for actually executing parsers. Given an input array, will parse the string with the parser. The result is either a Success or a Failure.

This method is responsible for actually executing parsers. Given an input array, will parse the string with the parser. The result is either a Success or a Failure.

Value Params
input

The input to run against

Returns

Either a success with a value of type A or a failure with error message

Since

3.0.0

def unsafe(): Unit

Using this method signifies that the parser it is invoked on is impure and any optimisations which assume purity are disabled.

Using this method signifies that the parser it is invoked on is impure and any optimisations which assume purity are disabled.