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

Op

laika.io.api.BinaryTreeRenderer$.Op
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.

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

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def describe: F[RendererDescriptor]

Provides a description of this operation, the renderers and extension bundles used, as well as the output target. This functionality is mostly intended for tooling support.

Provides a description of this operation, the renderers and extension bundles used, as well as the output target. This functionality is mostly intended for tooling support.

Attributes

def render: F[Unit]

Performs the rendering operation based on the library's default runtime implementation, suspended in the effect F.

Performs the rendering operation based on the library's default runtime implementation, suspended in the effect F.

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Concrete fields

val config: OperationConfig

The configuration of the renderer for the interim format.

The configuration of the renderer for the interim format.

Attributes

Generated with