Object

laika.rst.std

StandardDirectiveParsers

Related Doc: package std

Permalink

object StandardDirectiveParsers

Defines the custom argument and body parsers for the standard directives. Most of these delegate to the default block or inline parsers for reStructuredText, but often do only except one specific block type like Table or QuotedBlock whereas the default block parser usually accepts any of the blocks.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StandardDirectiveParsers
  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. def captionAndLegend(p: RecursiveParsers)(input: String): Either[String, (Seq[Span], Seq[Block])]

    Permalink

    Parses a caption (a single paragraph) and a legend (one or more blocks), both being optional.

    Parses a caption (a single paragraph) and a legend (one or more blocks), both being optional.

    p

    the standard block parsers including all registered directives for recursive use

    input

    the input to parse

    returns

    Right in case of parser success and Left in case of failure, to adjust to the Directive API

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. def parseDirectivePart[T](parser: Parser[T], source: String): Either[String, T]

    Permalink

    Utility method to be used by custom parsers for directive argument or body.

    Utility method to be used by custom parsers for directive argument or body. It translates a Success into a Right and a NoSuccess into a Left.

  17. def standardSpans(p: RecursiveParsers)(input: String): Either[String, Seq[Span]]

    Permalink

    Parses all standard inline markup supported by reStructuredText.

    Parses all standard inline markup supported by reStructuredText.

    p

    the standard inline parsers including all registered directives for recursive use

    input

    the input to parse

    returns

    Right in case of parser success and Left in case of failure, to adjust to the Directive API

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

    Permalink
    Definition Classes
    AnyRef

  19. def table(p: RecursiveParsers)(input: String): Either[String, Block]

    Permalink

    Parses one of the two table types supported by reStructuredText.

    Parses one of the two table types supported by reStructuredText.

    p

    the standard block parsers including all registered directives for recursive use

    input

    the input to parse

    returns

    Right in case of parser success and Left in case of failure, to adjust to the Directive API

  20. def target(p: RecursiveParsers)(input: String): Either[String, Span]

    Permalink

    Parses a target which might be a simple reference, a phrase reference or an uri.

    Parses a target which might be a simple reference, a phrase reference or an uri.

    input

    the input to parse

    returns

    Right in case of parser success and Left in case of failure, to adjust to the Directive API

  21. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  22. def unicode(input: String): Either[String, String]

    Permalink

    Parses unicode values in various notations intertwined with normal text.

    Parses unicode values in various notations intertwined with normal text.

    input

    the input to parse

    returns

    Right in case of parser success and Left in case of failure, to adjust to the Directive API

  23. final def wait(): Unit

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

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

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

  25. final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped