Object

laika.rst

InlineParsers

Related Doc: package rst

Permalink

object InlineParsers

Provides all inline parsers for reStructuredText.

Inline parsers deal with markup within a block of text, such as a link or emphasized text. They are used in the second phase of parsing, after the block parsers have cut the document into a (potentially nested) block structure.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InlineParsers
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. lazy val citationRef: SpanParserBuilder

    Permalink

    Parses a citation reference.

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def delimitedByMarkupEnd(end: String, postCondition: Parser[Any]): DelimitedText[String] with DelimiterOptions

    Permalink
  8. def delimitedByMarkupEnd(end: String): DelimitedText[String] with DelimiterOptions

    Permalink
  9. lazy val em: SpanParserBuilder

    Permalink

    Parses a span of emphasized text.

  10. lazy val email: SpanParserBuilder

    Permalink

    Parses a standalone email address (with no surrounding markup).

    Parses a standalone email address (with no surrounding markup).

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#standalone-hyperlinks

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. val escapedChar: Parser[String]

    Permalink

    Parses an escaped character.

    Parses an escaped character. For most characters it produces the character itself as the result with the only exception being an escaped space character which is removed from the output in reStructuredText.

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism.

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. lazy val footnoteRef: SpanParserBuilder

    Permalink

    Parses a footnote reference.

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. lazy val inlineLiteral: SpanParserBuilder

    Permalink

    Parses an inline literal element.

  19. lazy val internalTarget: SpanParserBuilder

    Permalink

    Parses an inline internal link target.

  20. lazy val interpretedTextWithRolePrefix: SpanParserBuilder

    Permalink

    Parses an interpreted text element with the role name as a prefix.

    Parses an interpreted text element with the role name as a prefix.

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#interpreted-text

  21. def interpretedTextWithRoleSuffix(defaultTextRole: String): SpanParserBuilder

    Permalink

    Parses an interpreted text element with the role name as a suffix.

    Parses an interpreted text element with the role name as a suffix.

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#interpreted-text

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def markupEnd(delimLength: Int): Parser[Any]

    Permalink

    Parses the end of an inline element according to reStructuredText markup recognition rules.

    Parses the end of an inline element according to reStructuredText markup recognition rules.

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup-recognition-rules.

    delimLength

    the length of the end delimiter that has already been consumed from the input

    returns

    a parser that succeeds without consuming any input when the rst markup end conditions are met

  24. def markupEnd(end: Parser[String]): Parser[String]

    Permalink

    Parses the end of an inline element according to reStructuredText markup recognition rules.

    Parses the end of an inline element according to reStructuredText markup recognition rules.

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup-recognition-rules.

    end

    the parser that recognizes the markup at the end of an inline element

    returns

    a parser that produces the same result as the parser passed as an argument

  25. def markupStart(end: Parser[String]): Parser[Any]

    Permalink

    Parses the start of an inline element without specific start markup according to reStructuredText markup recognition rules.

    Parses the start of an inline element without specific start markup according to reStructuredText markup recognition rules.

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup-recognition-rules.

    end

    the parser that recognizes the markup at the end of an inline element, needed to verify the start sequence is not immediately followed by an end sequence as empty elements are not allowed.

    returns

    a parser without a useful result, as it is only needed to verify it succeeds

  26. def markupStart(start: Parser[Any], end: Parser[String]): Parser[Any]

    Permalink

    Parses the markup at the start of an inline element according to reStructuredText markup recognition rules.

    Parses the markup at the start of an inline element according to reStructuredText markup recognition rules.

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup-recognition-rules.

    start

    the parser that recognizes the markup at the start of an inline element

    end

    the parser that recognizes the markup at the end of an inline element, needed to verify the start sequence is not immediately followed by an end sequence as empty elements are not allowed.

    returns

    a parser without a useful result, as it is only needed to verify it succeeds

  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. lazy val phraseLinkRef: SpanParserBuilder

    Permalink

    Parses a phrase link reference (enclosed in back ticks).

    Parses a phrase link reference (enclosed in back ticks).

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#hyperlink-references

  31. lazy val simpleLinkRef: SpanParserBuilder

    Permalink

    Parses a simple link reference.

  32. lazy val strong: SpanParserBuilder

    Permalink

    Parses a span of text with strong emphasis.

  33. lazy val substitutionRef: SpanParserBuilder

    Permalink

    Parses a substitution reference.

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

    Permalink
    Definition Classes
    AnyRef
  35. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  36. lazy val uri: SpanParserBuilder

    Permalink

    Parses a standalone HTTP or HTTPS hyperlink (with no surrounding markup).

    Parses a standalone HTTP or HTTPS hyperlink (with no surrounding markup).

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#standalone-hyperlinks

  37. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped