laika.parse.rst.Directives

Parts

object Parts

The public user API for specifying the required and optional parts of a directive (arguments, fields or body) together with optional converter/validator functions.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Parts
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def argument[T](convert: (String) ⇒ Either[String, T] = s:String => Right(s), withWS: Boolean = false): DirectivePart[T]

    Specifies a required argument.

    Specifies a required argument.

    convert

    the function to use for converting and validating the parsed value

    withWS

    whether the argument supports whitespace characters (only one of these can exist in any single directive markup)

    returns

    a directive part that can be combined with further parts with the ~ operator

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def blockContent: DirectivePart[Seq[Block]]

    Specifies standard block-level content as the body of the directive.

    Specifies standard block-level content as the body of the directive.

    returns

    a directive part that can be combined with further parts with the ~ operator

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def content[T](f: (String) ⇒ Either[String, T]): DirectivePart[T]

    Specifies that the body of the directive markup should get passed to the conversion function as a raw string.

    Specifies that the body of the directive markup should get passed to the conversion function as a raw string.

    returns

    a directive part that can be combined with further parts with the ~ operator

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

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

    Definition Classes
    AnyRef → Any
  13. def field[T](name: String, convert: (String) ⇒ Either[String, T] = s:String => Right(s)): DirectivePart[T]

    Specifies a required named field.

    Specifies a required named field.

    name

    the name of the field as used in the directive markup (without the colons)

    convert

    the function to use for converting and validating the parsed value

    returns

    a directive part that can be combined with further parts with the ~ operator

  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]

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

    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  21. def optArgument[T](convert: (String) ⇒ Either[String, T] = s:String => Right(s), withWS: Boolean = false): DirectivePart[Option[T]]

    Specifies an optional argument.

    Specifies an optional argument.

    convert

    the function to use for converting and validating the parsed value if it is present

    withWS

    whether the argument supports whitespace characters (only one of these can exist in any single directive markup)

    returns

    a directive part that can be combined with further parts with the ~ operator

  22. def optField[T](name: String, convert: (String) ⇒ Either[String, T] = s:String => Right(s)): DirectivePart[Option[T]]

    Specifies an optional named field.

    Specifies an optional named field.

    name

    the name of the field as used in the directive markup (without the colons)

    convert

    the function to use for converting and validating the parsed value if it is present

    returns

    a directive part that can be combined with further parts with the ~ operator

  23. def spanContent: DirectivePart[Seq[Span]]

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

    Definition Classes
    AnyRef
  25. def toString(): String

    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped