Packages

o

laika.rst.std

StandardDirectiveParsers

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
    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. def captionAndLegend(p: RecursiveParsers)(input: SourceFragment): Either[String, (Seq[Span], Seq[Block])]

    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
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def parseDirectivePart(parser: RecursiveSpanParser, source: SourceFragment): Either[String, Seq[Span]]

    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.

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

    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: SourceFragment): Either[String, Seq[Span]]

    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
    Definition Classes
    AnyRef
  19. def table(p: RecursiveParsers)(input: SourceFragment): Either[String, Block]

    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: SourceFragment): Either[String, Span]

    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
    Definition Classes
    AnyRef → Any
  22. def unicode(input: SourceFragment): Either[String, String]

    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(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  25. 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