laika-io
API
Generated with
laika-io/laika/laika.io/laika.io.api/BinaryTreeRenderer

BinaryTreeRenderer

laika.io.api.BinaryTreeRenderer$
See theBinaryTreeRenderer companion class
object BinaryTreeRenderer

Builder API for constructing a rendering operation for a tree of binary output documents.

Attributes

Companion
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

case class BinaryRenderer[F[_]](interimRenderer: Renderer, prepareTree: DocumentTreeRoot => Either[Throwable, DocumentTreeRoot], postProcessor: BinaryPostProcessor[F], description: String)(implicit evidence$3: Async[F])

A renderer that operates with two phases, producing an interim result.

A renderer that operates with two phases, producing an interim result.

Examples for such renderers are EPUB (with XHTML as the interim format) and PDF (with XSL-FO as the interim format).

This instance does not come with its own runtime. Instead its need to be passed to a builder API in laika-io that knows how to execute such an operation.

Value parameters

description

short string describing the output format for tooling and logging

interimRenderer

the renderer for the 1st phase, producing the interim result

postProcessor

the processor taking the interim result and producing the final result, the implementing type may vary from format to format

prepareTree

a hook with which the interim result can be modified before it gets passed to the post processor

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class Builder[F[_]](format: BinaryRenderFormat, config: OperationConfig, theme: Resource[F, Theme[F]])(implicit evidence$5: Async[F], evidence$6: Batch[F])

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

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

Attributes

Supertypes
class Object
trait Matchable
class Any
case class Op[F[_]](renderer: BinaryRenderer[F], theme: Theme[F], input: DocumentTreeRoot, output: BinaryOutput[F], staticDocuments: Seq[BinaryInput[F]])(implicit evidence$9: Async[F], evidence$10: Batch[F])

Represents a rendering operation for a tree of documents merged into a single binary output document.

Represents a rendering operation for a tree of documents merged into a single binary output document.

It can be run by invoking the render method which delegates to the library's default runtime implementation or by developing a custom runner that performs the rendering based on this operation's properties.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class OutputOps[F[_]](renderer: BinaryRenderer[F], theme: Theme[F], input: DocumentTreeRoot, staticDocuments: Seq[BinaryInput[F]])(implicit evidence$7: Async[F], evidence$8: Batch[F]) extends BinaryOutputOps[F]

Builder step that allows to specify the output to render to.

Builder step that allows to specify the output to render to.

Attributes

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

Types

type BinaryRenderFormat = TwoPhaseRenderFormat[_, BinaryPostProcessorBuilder]
Generated with