Packages

o

laika.rst

InlineParsers

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
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. lazy val citationRef: SpanParserBuilder

    Parses a citation reference.

    Parses a citation reference.

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

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. lazy val em: SpanParserBuilder

    Parses a span of emphasized text.

    Parses a span of emphasized text.

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#emphasis

  8. lazy val email: SpanParserBuilder

    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

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. val escapedChar: Parser[String]

    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.

  12. lazy val footnoteRef: SpanParserBuilder

    Parses a footnote reference.

    Parses a footnote reference.

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

  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. lazy val inlineLiteral: SpanParserBuilder

    Parses an inline literal element.

    Parses an inline literal element.

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

  16. lazy val internalTarget: SpanParserBuilder

    Parses an inline internal link target.

    Parses an inline internal link target.

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-internal-targets

  17. lazy val interpretedTextWithRolePrefix: SpanParserBuilder

    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

  18. def interpretedTextWithRoleSuffix(defaultTextRole: String): SpanParserBuilder

    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

  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def markupEnd(end: PrefixedParser[String]): PrefixedParser[String]

    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

  21. def markupEnd(end: String): PrefixedParser[String]

    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 literal string expected as the delimiter at the end of an inline element

    returns

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

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

    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

  23. def markupStart(start: String, end: String): PrefixedParser[Any]

    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 literal string at the start of an inline element

    end

    the literal string 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

  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. lazy val phraseLinkRef: SpanParserBuilder

    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

  28. lazy val simpleLinkRef: SpanParserBuilder

    Parses a simple link reference.

    Parses a simple link reference.

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

  29. lazy val strong: SpanParserBuilder

    Parses a span of text with strong emphasis.

    Parses a span of text with strong emphasis.

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#strong-emphasis

  30. lazy val substitutionRef: SpanParserBuilder

    Parses a substitution reference.

    Parses a substitution reference.

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

  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. lazy val uri: SpanParserBuilder

    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

  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped