Builder

laika.io.api.TreeTransformer$.Builder
case class Builder[F[_]](parsers: NonEmptyList[MarkupParser], renderer: Renderer, theme: ThemeProvider, mapper: TreeMapper[F])(implicit evidence$3: Async[F], evidence$4: Batch[F]) extends TreeMapperOps[F]

Builder step that allows to specify the execution context for blocking IO and CPU-bound tasks.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class TreeMapperOps[F]
class Object
trait Matchable
class Any
Show all

Members list

Type members

Types

type MapRes = Builder[F]

Value members

Concrete methods

def build: Resource[F, TreeTransformer[F]]

Final builder step that creates a parallel transformer.

Final builder step that creates a parallel transformer.

Attributes

def evalMapTree(f: ParsedTree[F] => F[ParsedTree[F]]): MapRes

Creates a new transformer that applies the specified effectful function to the parsed tree before rendering.

Creates a new transformer that applies the specified effectful function to the parsed tree before rendering.

Attributes

def withAlternativeParser(parser: MarkupParser): Builder[F]

Specifies an additional parser for text markup.

Specifies an additional parser for text markup.

When multiple parsers exist for an operation, the target parser will be determined by the suffix of the input document, e.g. .md for Markdown and .rst for reStructuredText.

Attributes

def withAlternativeParser(parser: ParserBuilder): Builder[F]

Specifies an additional parser for text markup.

Specifies an additional parser for text markup.

When multiple parsers exist for an operation, the target parser will be determined by the suffix of the input document, e.g. .md for Markdown and .rst for reStructuredText.

Attributes

def withTheme(theme: ThemeProvider): Builder[F]

Applies the specified theme to this transformer, overriding any previously specified themes.

Applies the specified theme to this transformer, overriding any previously specified themes.

Attributes

Inherited methods

def evalMapDocuments(f: Document => F[Document]): MapRes

Creates a new transformer that applies the specified effectful function to each document in the parsed tree before rendering.

Creates a new transformer that applies the specified effectful function to each document in the parsed tree before rendering.

Attributes

Inherited from:
TreeMapperOps
def mapDocuments(f: Document => Document): MapRes

Creates a new transformer that applies the specified function to each document in the parsed tree before rendering.

Creates a new transformer that applies the specified function to each document in the parsed tree before rendering.

Attributes

Inherited from:
TreeMapperOps
def mapTree(f: ParsedTree[F] => ParsedTree[F]): MapRes

Creates a new transformer that applies the specified function to the parsed tree before rendering.

Creates a new transformer that applies the specified function to the parsed tree before rendering.

Attributes

Inherited from:
TreeMapperOps
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Inherited fields

val F: Sync[F]

Attributes

Inherited from:
TreeMapperOps