laika-core
API
Generated with
laika-core/laika/laika.parse/laika.parse.markup/DocumentParser

DocumentParser

laika.parse.markup.DocumentParser$
object DocumentParser

Responsible for creating the top level parsers for text markup and template documents, by combining the parser for the root element with a parser for an (optional) configuration header.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

case class DocumentInput(path: Path, source: SourceCursor)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DocumentInput

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class InvalidDocument(errors: Either[Type[ConfigError], Type[Invalid]], path: Path) extends RuntimeException

Attributes

Companion
object
Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object InvalidDocument

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class InvalidDocuments(documents: Type[InvalidDocument]) extends RuntimeException

Attributes

Companion
object
Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object InvalidDocuments

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ParserError(message: String, path: Path) extends RuntimeException, TransformationError

Attributes

Companion
object
Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object ParserError

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class RendererError(message: String, path: Path) extends RuntimeException, TransformationError

Attributes

Companion
object
Supertypes
trait Product
trait Equals
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object RendererError

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait TransformationError extends RuntimeException

Attributes

Supertypes
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class ParserError

Value members

Concrete methods

def forMarkup(markupParser: MarkupFormat, markupExtensions: MarkupExtensions, configProvider: ConfigProvider): DocumentInput => Either[ParserError, UnresolvedDocument]

Combines the specified markup parsers and extensions and the parser for (optional) configuration headers to create a parser function for an entire text markup document.

Combines the specified markup parsers and extensions and the parser for (optional) configuration headers to create a parser function for an entire text markup document.

Attributes

def forMarkup(rootParser: Parser[RootElement], configProvider: ConfigProvider): DocumentInput => Either[ParserError, UnresolvedDocument]

Combines the specified parsers for the root element and for (optional) configuration headers to create a parser function for an entire text markup document.

Combines the specified parsers for the root element and for (optional) configuration headers to create a parser function for an entire text markup document.

Attributes

def forParser[T](p: Path => Parser[T]): DocumentInput => Either[ParserError, T]

A document parser function for the specified parser that is expected to consume all input.

A document parser function for the specified parser that is expected to consume all input.

The specified function is invoked for each parsed document, so that a parser dependent on the input path can be created.

Attributes

def forStyleSheets(parser: Parser[Set[StyleDeclaration]]): DocumentInput => Either[ParserError, StyleDeclarationSet]

Builds a document parser for CSS documents based on the specified parser for style declarations.

Builds a document parser for CSS documents based on the specified parser for style declarations.

Attributes

def forTemplate(rootParser: Parser[TemplateRoot], configProvider: ConfigProvider): DocumentInput => Either[ParserError, TemplateDocument]

Combines the specified parsers for the root element and for (optional) configuration headers to create a parser function for an entire template document.

Combines the specified parsers for the root element and for (optional) configuration headers to create a parser function for an entire template document.

Attributes

Generated with