parsley
package parsley
- Alphabetic
- Public
- Protected
Type Members
- class Failure[Err] extends Result[Err, Nothing] with Product with Serializable
Returned on parsing failure
- final class Parsley[+A] extends AnyVal
This is the class that encapsulates the act of parsing and running an object of this class with
parsewill parse the string given as input toparse.This is the class that encapsulates the act of parsing and running an object of this class with
parsewill parse the string given as input toparse.Note: In order to construct an object of this class you must use the combinators; the class itself is abstract
- Version
1
- sealed trait Result[+Err, +A] extends AnyRef
Result of a parser.
Result of a parser. Either a
Success[A]or aFailure- A
The type of expected success result
- case class Success[A] extends Result[Nothing, A] with Product with Serializable
Returned when a parser succeeded.
Returned when a parser succeeded.
- A
The type of expected success result
Value Members
- object Failure extends Serializable
- object Parsley
This object contains the core "function-style" combinators as well as the implicit classes which provide the "method-style" combinators.
This object contains the core "function-style" combinators as well as the implicit classes which provide the "method-style" combinators. All parsers will likely require something from within!
- object character
This module contains many parsers to do with reading one or more characters.
This module contains many parsers to do with reading one or more characters. Almost every parser will need something from this module.
- Since
2.2.0
- object combinator
This module contains a huge number of pre-made combinators that are very useful for a variety of purposes.
This module contains a huge number of pre-made combinators that are very useful for a variety of purposes.
- Since
2.2.0
- object debug
This module contains the very useful debugging combinator, as well as breakpoints.
- object io
This module contains utilities to have parsers interact with IO, including the very useful
parseFromFilemethod (exposed byParseFromIO)This module contains utilities to have parsers interact with IO, including the very useful
parseFromFilemethod (exposed byParseFromIO)- Since
3.0.0
- object lift
This module contains
lift1throughlift22, which allow for the application of aFunctionNtoNparsers for example:This module contains
lift1throughlift22, which allow for the application of aFunctionNtoNparsers for example:lift2[Int, Int, Int](_+_, px, py): Parsley[Int]
, lift3((x: Int, y: Int, z: Int) => x + y + z, px, py, pz): Parsley[Int]
- Since
2.2.0
Examples: - object registers
This module contains all the functionality and operations for using and manipulating registers.
This module contains all the functionality and operations for using and manipulating registers.
- Since
2.2.0
- object unsafe
This module contains various things that shouldn't be used without care and caution
This module contains various things that shouldn't be used without care and caution
- Since
1.6.0
This is the documentation for Parsley.
Package structure
The parsley package contains the
Parsleyclass, as well as theResult,Success, andFailuretypes. In addition to these, it also contains the following packages and "modules" (a module is defined as being an object which mocks a package):parsley.Parsleycontains the bulk of the core "function-style" combinators, as well as the implicit classes which enable the "method-style" combinators.parsley.combinatorcontains many helpful combinators that simplify some common parser patterns.parsley.charactercontains the combinators needed to read characters and strings, as well as combinators to match specific sub-sets of characters.parsley.debugcontains debugging combinators, helpful for identifying faults in parsers.parsley.iocontains extension methods to run parsers with input sourced from IO sources.parsley.exprcontains the following sub modules:parsley.expr.chaincontains combinators used in expression parsingparsley.expr.precedenceis a builder for expression parsers built on a precedence table.parsley.implicitscontains several implicits to add syntactic sugar to the combinators. These are sub-categorised into the following sub modules:parsley.implicits.charactercontains implicits to allow you to use character and string literals as parsers.parsley.implicits.combinatorcontains implicits related to combinators, such as the ability to make any parser into aParsley[Unit]automatically.parsley.implicits.liftenables postfix application of the lift combinator onto a function (or value).parsley.implicits.zippedenables boths a reversed form of lift where the function appears on the right and is applied on a tuple (useful when type inference has failed) as well as a.zippedmethod for building tuples out of several combinators.parsley.errorscontains modules to deal with error messages, their refinement and generation.parsley.errors.combinatorprovides combinators that can be used to either produce more detailed errors as well as refine existing errors.parsley.liftcontains functions which lift functions that work on regular types to those which now combine the results of parsers returning those same types. these are ubiquitous.parsley.registerscontains combinators that interact with the context-sensitive functionality in the form of registers.parsley.tokencontains theLexerclass that provides a host of helpful lexing combinators when provided with the description of a language.parsley.unsafecontains unsafe (and not thread-safe) ways of speeding up the execution of a parser.