laika-docs
1.1.0
API
Generated with
laika-docs/laika/laika.parse/laika.parse.text/TextParsers

TextParsers

laika.parse.text.TextParsers
See theTextParsers companion trait
object TextParsers extends TextParsers

Instance that allows to import all text parsers in isolation.

Usually it is more convenient to import laika.parse.api._ to get all parser builders with one import.

Attributes

Companion
trait
Source
TextParsers.scala
Graph
Supertypes
trait TextParsers
trait Parsers
class Object
trait Matchable
class Any
Self type

Members list

Type members

Inherited classlikes

implicit class TryOps[A](t: Try[A])

Provides additional methods to Try via implicit conversion.

Provides additional methods to Try via implicit conversion.

Attributes

Inherited from:
Parsers
Source
Parsers.scala
Supertypes
class Object
trait Matchable
class Any

Value members

Inherited methods

def anyNot(chars: Type[Char]): Characters[String]

Consumes any number of consecutive occurrences that are not one of the specified characters.

Consumes any number of consecutive occurrences that are not one of the specified characters. Always succeeds unless a minimum number of required matches is specified.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def anyNot(char: Char, 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.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def anyOf(chars: Type[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.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def anyOf(char: Char, 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.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
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.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
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.

Attributes

Inherited from:
Parsers
Source
Parsers.scala
def delimitedBy(delimiter: PrefixedParser[String]): DelimitedText

Consumes any number of consecutive characters until the specified delimiter parser succeeds on the input.

Consumes any number of consecutive characters until the specified delimiter parser succeeds on the input.

This constructor is limited to the sub-trait PrefixedParser as only those can be optimized for an assertion that needs to be performed on each character. Most parsers for non-empty text implement this trait, e.g oneOf, someOf, delimiter or the literal parsers for a character or string.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def delimitedBy(str: String): DelimitedText

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.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def delimitedBy(chars: Type[Char]): DelimitedText

Consumes any number of consecutive characters until one of the specified characters is encountered on the input string.

Consumes any number of consecutive characters until one of the specified characters is encountered on the input string.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def delimitedBy(char: Char, chars: Char*): DelimitedText

Consumes any number of consecutive characters until one of the specified characters is encountered on the input string.

Consumes any number of consecutive characters until one of the specified characters is encountered on the input string.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def delimiter(parser: PrefixedParser[String]): DelimiterParser

Creates a parser for a delimiter with an API that allows to specify predicates for the characters immediately preceding or following the delimiter, a common task in markup parsing.

Creates a parser for a delimiter with an API that allows to specify predicates for the characters immediately preceding or following the delimiter, a common task in markup parsing.

This specified underlying parser needs to implement the sub-trait PrefixedParser as only those can be optimized for an assertion that needs to be performed on each character. Most parsers for non-empty text implement this trait, e.g oneOf, someOf, delimiter or the literal parsers for a character or string.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def delimiter(delim: String): DelimiterParser

Creates a parser for a delimiter based on a literal string with an API that allows to specify predicates for the characters immediately preceding or following the delimiter, a common task in markup parsing.

Creates a parser for a delimiter based on a literal string with an API that allows to specify predicates for the characters immediately preceding or following the delimiter, a common task in markup parsing.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def delimiter(char: Char, chars: Char*): DelimiterParser

Creates a parser for a delimiter based on the given set of delimiter characters with an API that allows to specify predicates for the characters immediately preceding or following the delimiter, a common task in markup parsing.

Creates a parser for a delimiter based on the given set of delimiter characters with an API that allows to specify predicates for the characters immediately preceding or following the delimiter, a common task in markup parsing.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def failure(msg: String): Parser[Nothing]

A parser that always fails with the specified message.

A parser that always fails with the specified message.

Attributes

Inherited from:
Parsers
Source
Parsers.scala
def lazily[T](p: => Parser[T]): Parser[T]

Constructs a parser lazily, useful when breaking circles in recursive parsing.

Constructs a parser lazily, useful when breaking circles in recursive parsing.

Attributes

Inherited from:
Parsers
Source
Parsers.scala
def literal(expected: String): PrefixedParser[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.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def lookAhead(offset: Int, value: String): Parser[String]

Attempts to parse the specified literal value at the specified offset behind the current position.

Attempts to parse the specified literal value at the specified offset behind the current position. Never consumes any input.

Attributes

Inherited from:
Parsers
Source
Parsers.scala
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.

Attributes

Inherited from:
Parsers
Source
Parsers.scala
def lookAhead(value: String): Parser[String]

Attempts to parse the specified literal value at the current position.

Attempts to parse the specified literal value at the current position. Never consumes any input.

Attributes

Inherited from:
Parsers
Source
Parsers.scala
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.

Attributes

Inherited from:
Parsers
Source
Parsers.scala
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.

Attributes

Inherited from:
Parsers
Source
Parsers.scala
def nextIn(chars: Type[Char]): Parser[Unit]

Verifies that the next character is one of those specified.

Verifies that the next character is one of those specified. Fails at the end of the input and does not consume any input or produce a result when it succeeds.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def nextIn(char: Char, chars: Char*): Parser[Unit]

Verifies that the next character is one of those specified.

Verifies that the next character is one of those specified. Fails at the end of the input and does not consume any input or produce a result when it succeeds.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def nextIs(predicate: Char => Boolean): Parser[Unit]

Verifies that the next character does not satisfy the specified predicate.

Verifies that the next character does not satisfy the specified predicate. Fails at the end of the input and does not consume any input or produce a result when it succeeds.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def nextNot(predicate: Char => Boolean): Parser[Unit]

Verifies that the next character does not satisfy the specified predicate.

Verifies that the next character does not satisfy the specified predicate. Succeeds at the end of the input and does not consume any input or produce a result when it succeeds.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def nextNot(chars: Type[Char]): Parser[Unit]

Verifies that the next character is not one of those specified.

Verifies that the next character is not one of those specified. Succeeds at the end of the input and does not consume any input or produce a result when it succeeds.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def nextNot(char: Char, chars: Char*): Parser[Unit]

Verifies that the next character is not one of those specified.

Verifies that the next character is not one of those specified. Succeeds at the end of the input and does not consume any input or produce a result when it succeeds.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def not(value: String): Parser[Unit]

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

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

Attributes

Inherited from:
Parsers
Source
Parsers.scala
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.

Attributes

Inherited from:
Parsers
Source
Parsers.scala
def oneIf(p: Char => Boolean): Parser[String]

Consumes one character if it satisfies the specified predicate, fails otherwise.

Consumes one character if it satisfies the specified predicate, fails otherwise.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def oneNot(chars: Type[Char]): Parser[String]

Consumes one character if it is not one of the specified characters.

Consumes one character if it is not one of the specified characters.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def oneNot(char: Char, chars: Char*): Parser[String]

Consumes one character if it is not one of the specified characters.

Consumes one character if it is not one of the specified characters.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def oneOf(chars: Type[Char]): PrefixedParser[String]

Consumes one character if it matches one of the specified characters, fails otherwise.

Consumes one character if it matches one of the specified characters, fails otherwise.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def oneOf(char: Char, chars: Char*): PrefixedParser[String]

Consumes one character if it matches one of the specified characters, fails otherwise.

Consumes one character if it matches one of the specified characters, fails otherwise.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def opt(value: String): Parser[Option[String]]

A parser for an optional literal string that always succeeds.

A parser for an optional literal string 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.

Attributes

Inherited from:
Parsers
Source
Parsers.scala
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.

Attributes

Inherited from:
Parsers
Source
Parsers.scala
def prevIn(chars: Type[Char]): Parser[Unit]

Verifies that the previous character is one of those specified.

Verifies that the previous character is one of those specified. Fails at the start of the input and does not consume any input or produce a result when it succeeds.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def prevIn(char: Char, chars: Char*): Parser[Unit]

Verifies that the previous character is one of those specified.

Verifies that the previous character is one of those specified. Fails at the start of the input and does not consume any input or produce a result when it succeeds.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def prevIs(predicate: Char => Boolean): Parser[Unit]

Verifies that the previous character satisfies the specified predicate.

Verifies that the previous character satisfies the specified predicate. Fails at the start of the input and does not consume any input or produce a result when it succeeds.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def prevNot(predicate: Char => Boolean): Parser[Unit]

Verifies that the previous character does not satisfy the specified predicate.

Verifies that the previous character does not satisfy the specified predicate. Succeeds at the start of the input and does not consume any input or produce a result when it succeeds.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def prevNot(chars: Type[Char]): Parser[Unit]

Verifies that the previous character is not one of those specified.

Verifies that the previous character is not one of those specified. Succeeds at the start of the input and does not consume any input or produce a result when it succeeds.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def prevNot(char: Char, chars: Char*): Parser[Unit]

Verifies that the previous character is not one of those specified.

Verifies that the previous character is not one of those specified. Succeeds at the start of the input and does not consume any input or produce a result when it succeeds.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def range(fromChar: Char, toChar: Char): Type[Char]

Creates a NonEmptySet from a Character range.

Creates a NonEmptySet from a Character range. This set can then be passed to parsers like anyOf or oneOf which expect a NonEmptySet as a parameter.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def someNot(chars: Type[Char]): Characters[String]

Consumes one or more characters that are not one of the specified characters, fails for empty results.

Consumes one or more characters that are not one of the specified characters, fails for empty results.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def someNot(char: Char, chars: Char*): Characters[String]

Consumes one or more characters that are not one of the specified characters, fails for empty results.

Consumes one or more characters that are not one of the specified characters, fails for empty results.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def someOf(chars: Type[Char]): PrefixCharacters[String]

Consumes one or more characters if they match one of the specified characters, fails if the first character does not match.

Consumes one or more characters if they match one of the specified characters, fails if the first character does not match.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def someOf(char: Char, chars: Char*): PrefixCharacters[String]

Consumes one or more characters if they match one of the specified characters, fails if the first character does not match.

Consumes one or more characters if they match one of the specified characters, fails if the first character does not match.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
def someWhile(p: Char => Boolean): Characters[String]

Consumes one or more characters which satisfy the specified predicate, fails for empty results.

Consumes one or more characters which satisfy the specified predicate, fails for empty results.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
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.

Attributes

Inherited from:
Parsers
Source
Parsers.scala

Inherited fields

val anyChars: 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.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
val atStart: Parser[Unit]

Succeeds at the start of the input.

Succeeds at the start of the input.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
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.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
val blankLines: Parser[List[String]]

Parses one or more blank lines, producing a list of empty strings corresponding to the number of blank lines consumed.

Parses one or more blank lines, producing a list of empty strings corresponding to the number of blank lines consumed.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
val eof: Parser[String]

Succeeds at the end of the input.

Succeeds at the end of the input.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
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.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
val oneChar: Parser[String]

Parses exactly one character from the input, fails only at the end of the input.

Parses exactly one character from the input, fails only at the end of the input.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
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).

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
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).

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
lazy val ws: Characters[String]

Parses horizontal whitespace (space and tab).

Parses horizontal whitespace (space and tab). Always succeeds, consuming all whitespace found.

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala
val wsEol: Parser[Unit]

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

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

Attributes

Inherited from:
TextParsers
Source
TextParsers.scala

Implicits

Inherited implicits

final implicit def TryOps[A](t: Try[A]): TryOps[A]

Provides additional methods to Try via implicit conversion.

Provides additional methods to Try via implicit conversion.

Attributes

Inherited from:
Parsers
Source
Parsers.scala
Generated with