Packages

  • package root

    This is the documentation for Parsley.

    This is the documentation for Parsley.

    Package structure

    The parsley package contains the Parsley class, as well as the Result, Success, and Failure types. 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.Parsley contains the bulk of the core "function-style" combinators, as well as the implicit classes which enable the "method-style" combinators.
    • parsley.combinator contains many helpful combinators that simplify some common parser patterns.
    • parsley.character contains the combinators needed to read characters and strings, as well as combinators to match specific sub-sets of characters.
    • parsley.debug contains debugging combinators, helpful for identifying faults in parsers.
    • parsley.expr contains the following sub modules:
    • parsley.implicits contains several implicits to add syntactic sugar to the combinators, such as being able to use character and string literals directly as parsers, as well as enabling lifting of functions to work on parsers.
    • parsley.lift contains 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.registers contains combinators that interact with the context-sensitive functionality in the form of registers.
    • parsley.token contains the Lexer class that provides a host of helpful lexing combinators when provided with the description of a language.
    • parsley.unsafe contains unsafe (and not thread-safe) ways of speeding up the execution of a parser.

    In addition to the modules and packages outlined above, this version of Parsley (up to version 3.0), also includes the so-called old-style API, which is deprecated (see the Parsley wiki for a discussion of these differences). You should use the modules described above, and avoid the following:

    • parsley.BitGen
    • parsley.Char
    • parsley.CharSet
    • parsley.Combinator
    • parsley.ExpressionParser
    • parsley.Impl
    • parsley.Implicits
    • parsley.LanguageDef
    • parsley.NotRequired
    • parsley.Parser
    • parsley.Predicate
    • parsley.Reg
    • parsley.TokenParser
    Definition Classes
    root
  • package parsley
    Definition Classes
    root
  • package expr
    Definition Classes
    parsley
  • package internal
    Definition Classes
    parsley
  • package token
    Definition Classes
    parsley
  • BitGen
  • Char
  • CharSet
  • Combinator
  • ExpressionParser
  • Failure
  • Impl
  • Implicits
  • LanguageDef
  • NotRequired
  • Parser
  • Parsley
  • Predicate
  • Reg
  • Result
  • Success
  • TokenParser
  • character
  • combinator
  • debug
  • implicits
  • lift
  • registers
  • unsafe

final class Parsley[+A] extends AnyVal

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

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

Version

1

Linear Supertypes
AnyVal, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Parsley
  2. AnyVal
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##: Int
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def force(): Unit

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

  6. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  7. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  8. def overflows(): Unit

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

  9. def parseFromFile(file: File): Result[A]

    This method executes a parser, but collects the input to the parser from the given file.

    This method executes a parser, but collects the input to the parser from the given file. The file name is used to annotate any error messages.

    file

    The file to load and run against

    returns

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

    Since

    2.3.0

  10. def runParser(input: Array[Char]): Result[A]

    This method is responsible for actually executing parsers.

    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.

    input

    The input to run against

    returns

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

  11. def runParser(input: String): Result[A]

    This method is responsible for actually executing parsers.

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

    input

    The input to run against

    returns

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

  12. def toString(): String
    Definition Classes
    Any
  13. def unsafe(): Unit

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

Inherited from AnyVal

Inherited from Any

Ungrouped