Object

laika.parse.directive

ConfigHeaderParser

Related Doc: package directive

Permalink

object ConfigHeaderParser

Provides parser implementation for configuration header sections in text markup files, which are expected to be in HOCON format as defined in the Typesafe Config library.

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

Type Members

  1. type ConfigHeaderParser = Parser[Either[InvalidElement, Config]]

    Permalink

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 betweenLines(startDelim: String, endDelim: String)(path: Path): ConfigHeaderParser

    Permalink

    Parser for configuration headers which are enclosed between the specified start and end delimiters.

    Parser for configuration headers which are enclosed between the specified start and end delimiters. These delimiters are expected to be both on a separate line.

  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. val fallback: (Path) ⇒ Parser[Either[InvalidElement, Config]]

    Permalink
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def forTextParser(parser: Parser[String])(path: Path): ConfigHeaderParser

    Permalink

    Generic base parser for configuration headers based on the specified string parser.

    Generic base parser for configuration headers based on the specified string parser.

    The parser is expected to detect and consume any start and end delimiters without adding them to the result which is supposed to be a string in HOCON format.

    The contract for such a parser is that it fails if it cannot successfully read the expected start or end delimiters, so that other parsers (if defined) can be tried instead.

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

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

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

    Permalink
    Definition Classes
    Any
  15. def merge(config: Config, values: Map[String, AnyRef]): Config

    Permalink
  16. def merged(parsers: Seq[(Path) ⇒ ConfigHeaderParser])(path: Path): ConfigHeaderParser

    Permalink

    Merges the specified parsers so that they will be tried consecutively until one of them succeeds.

    Merges the specified parsers so that they will be tried consecutively until one of them succeeds. If all of them fail, the merged parser will fail, too.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  20. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. def withDefaultLineDelimiters(path: Path): ConfigHeaderParser

    Permalink

    Parser for default configuration headers which are enclosed between lines containing {% and %} respectively.

Inherited from AnyRef

Inherited from Any

Ungrouped