TextParsers

Type Members

case class ParserException(result: Failure) extends RuntimeException with Product with Serializable

Definition Classes
Parsers
implicit class TryOps[A] extends AnyRef

Provides additional methods to Try via implicit conversion.
Provides additional methods to Try via implicit conversion.

Definition Classes
Parsers

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
val any: Characters[String]

Consumes any kind of input, always succeeds.
Consumes any kind of input, always succeeds. This parser would consume the entire input unless a max constraint is specified.
def anyBut(chars: Char*): Characters[String]

Consumes any number of consecutive characters that are not one of the specified characters.
Consumes any number of consecutive characters that are not one of the specified characters. Always succeeds unless a minimum number of required matches is specified.
def anyIn(ranges: Iterable[Char]*): Characters[String]

Consumes any number of consecutive characters that are in one of the specified character ranges.
Consumes any number of consecutive characters that are in one of the specified character ranges. Always succeeds unless a minimum number of required matches is specified.
def anyOf(chars: Char*): Characters[String]

Consumes any number of consecutive occurrences of the specified characters.
Consumes any number of consecutive occurrences of the specified characters. Always succeeds unless a minimum number of required matches is specified.
def anyWhile(p: (Char) ⇒ Boolean): Characters[String]

Consumes any number of consecutive characters which satisfy the specified predicate.
Consumes any number of consecutive characters which satisfy the specified predicate. Always succeeds unless a minimum number of required matches is specified.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val atStart: Parser[Unit]

Succeeds at the start of the input.
val blankLine: Parser[String]

Parses a blank line from the current input offset (which may not be at the start of the line).
Parses a blank line from the current input offset (which may not be at the start of the line). Fails for lines that contain any non-whitespace character. Does always produce an empty string as the result, discarding any whitespace characters found in the line.
Since it also succeeds at the end of the input it should never be used in the form of (blankLine *) or (blankLine +). Use the blankLines parser instead in these cases.
val blankLines: Parser[List[String]]

Parses one or more blanklines, producing a list of empty strings corresponding to the number of blank lines consumed.
implicit def char(expected: Char): Parser[Char]

A parser that matches only the specified character.
A parser that matches only the specified character.
The method is implicit so that characters can automatically be lifted to their parsers.
implicit def charToIterable(char: Char): Iterable[Char]

Implicit conversion that allows to pass a single character to the range-based anyIn parser.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def consumeAll[T](p: Parser[T]): Parser[T]

A parser that succeeds if the specified parser succeeds and all input has been consumed.
A parser that succeeds if the specified parser succeeds and all input has been consumed.

Definition Classes
Parsers
def delimitedBy(str: String, postCondition: Parser[Any]): DelimitedText[String] with DelimiterOptions

Consumes any number of consecutive characters until the specified string delimiter is encountered on the input string.
Consumes any number of consecutive characters until the specified string delimiter is encountered on the input string.
Only succeeds if the specified postCondition parser succeeds at the offset after the consumed delimiter string.
def delimitedBy(str: String): DelimitedText[String] with DelimiterOptions

Consumes any number of consecutive characters until the specified string delimiter is encountered on the input string.
def delimitedBy(chars: Char*): DelimitedText[String] with DelimiterOptions

Consumes any number of consecutive characters until one of the specified characters is encountered on the input string.
def documentParserFunction[T, U](parser: Parser[T], docF: (Path, T) ⇒ U): (Input) ⇒ U

A parser function for the specified parser that is expected to consume all input and always succeed, throwing unexpected parser failures as exceptions instead.
A parser function for the specified parser that is expected to consume all input and always succeed, throwing unexpected parser failures as exceptions instead.
The docF function turns the result of the parser into a document instance.

Definition Classes
Parsers
val eof: Parser[String]

Succeeds at the end of the input.
val eol: Parser[Unit]

Succeeds at the end of a line, including the end of the input.
Succeeds at the end of a line, including the end of the input. Produces an empty string as a result and consumes any new line characters.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def failure(msg: String): Parser[Nothing]

A parser that always fails with the specified message.
A parser that always fails with the specified message.

Definition Classes
Parsers
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
implicit def literal(expected: String): Parser[String]

A parser that matches only the specified literal string.
A parser that matches only the specified literal string.
The method is implicit so that strings can automatically be lifted to their parsers.
def lookAhead[T](offset: Int, p: Parser[T]): Parser[T]

Applies the specified parser at the specified offset behind the current position.
Applies the specified parser at the specified offset behind the current position. Never consumes any input.

Definition Classes
Parsers
def lookAhead[T](p: Parser[T]): Parser[T]

Applies the specified parser at the current position.
Applies the specified parser at the current position. Never consumes any input.

Definition Classes
Parsers
def lookBehind[T](offset: Int, parser: ⇒ Parser[T]): Parser[T]

Applies the specified parser at the specified offset behind the current position.
Applies the specified parser at the specified offset behind the current position. Never consumes any input.

Definition Classes
Parsers
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def not[T](p: Parser[T]): Parser[Unit]

A parser that only succeeds if the specified parser fails and vice versa, it never consumes any input.
A parser that only succeeds if the specified parser fails and vice versa, it never consumes any input.

Definition Classes
Parsers
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def opt[T](p: Parser[T]): Parser[Option[T]]

A parser for an optional element that always succeeds.
A parser for an optional element that always succeeds.
If the underlying parser succeeds this parser will contain its result as a Some, if it fails this parser will succeed with a None.

Definition Classes
Parsers
val refName: Parser[String]

Parses a simple reference name that only allows alphanumerical characters and the punctuation characters -, _, ., :, +.
val restOfLine: Parser[String]

Parses the rest of the line from the current input offset no matter whether it consist of whitespace only or some text.
Parses the rest of the line from the current input offset no matter whether it consist of whitespace only or some text. Does not include the eol character(s).
val sizeAndUnit: Parser[Size]

Parses a size and its amount, e.g.
Parses a size and its amount, e.g. 12px. The unit is mandatory and not validated.
def success[T](v: T): Parser[T]

A parser that always succeeds with the specified value.
A parser that always succeeds with the specified value.

Definition Classes
Parsers
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val textLine: Parser[String]

Parses a single text line from the current input offset (which may not be at the start of the line).
Parses a single text line from the current input offset (which may not be at the start of the line). Fails for blank lines. Does not include the eol character(s).
def toString(): String

Definition Classes
AnyRef → Any
def unsafeParserFunction[T](parser: Parser[T]): (ParserContext) ⇒ T

A parser function for the specified parser that is expected to consume all input and always succeed, throwing unexpected parser failures as exceptions instead.
A parser function for the specified parser that is expected to consume all input and always succeed, throwing unexpected parser failures as exceptions instead.

Definition Classes
Parsers
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( ... )
lazy val ws: Characters[String]

Parses horizontal whitespace (space and tab).
Parses horizontal whitespace (space and tab). Always succeeds, consuming all whitespace found.
val wsEol: Parser[Unit]

Parses any number of whitespace characters followed by a newline character.

Related Doc: package text

object TextParsers extends Parsers

Type Members

case class ParserException(result: Failure) extends RuntimeException with Product with Serializable

implicit class TryOps[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val any: Characters[String]

def anyBut(chars: Char*): Characters[String]

def anyIn(ranges: Iterable[Char]*): Characters[String]

def anyOf(chars: Char*): Characters[String]

def anyWhile(p: (Char) ⇒ Boolean): Characters[String]

final def asInstanceOf[T0]: T0

val atStart: Parser[Unit]

val blankLine: Parser[String]

val blankLines: Parser[List[String]]

implicit def char(expected: Char): Parser[Char]

implicit def charToIterable(char: Char): Iterable[Char]

def clone(): AnyRef

def consumeAll[T](p: Parser[T]): Parser[T]

def delimitedBy(str: String, postCondition: Parser[Any]): DelimitedText[String] with DelimiterOptions

def delimitedBy(str: String): DelimitedText[String] with DelimiterOptions

def delimitedBy(chars: Char*): DelimitedText[String] with DelimiterOptions

def documentParserFunction[T, U](parser: Parser[T], docF: (Path, T) ⇒ U): (Input) ⇒ U

val eof: Parser[String]

val eol: Parser[Unit]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def failure(msg: String): Parser[Nothing]

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

implicit def literal(expected: String): Parser[String]

def lookAhead[T](offset: Int, p: Parser[T]): Parser[T]

def lookAhead[T](p: Parser[T]): Parser[T]

def lookBehind[T](offset: Int, parser: ⇒ Parser[T]): Parser[T]

final def ne(arg0: AnyRef): Boolean

def not[T](p: Parser[T]): Parser[Unit]

final def notify(): Unit

final def notifyAll(): Unit

def opt[T](p: Parser[T]): Parser[Option[T]]

val refName: Parser[String]

val restOfLine: Parser[String]

val sizeAndUnit: Parser[Size]

def success[T](v: T): Parser[T]

final def synchronized[T0](arg0: ⇒ T0): T0

val textLine: Parser[String]

def toString(): String

def unsafeParserFunction[T](parser: Parser[T]): (ParserContext) ⇒ T

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

lazy val ws: Characters[String]

val wsEol: Parser[Unit]

Inherited from Parsers

Inherited from AnyRef

Inherited from Any

Ungrouped