OutputOps

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

Attributes

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

Members list

Type members

Types

type Result = Op[F]

Value members

Concrete methods

def copying(toCopy: Seq[BinaryInput[F]]): OutputOps[F]

Copies the specified binary input to the output target, in addition to rendering the document tree.

Copies the specified binary input to the output target, in addition to rendering the document tree.

Attributes

def toOutput(output: BinaryOutput[F]): Op[F]

Builder step that instructs the runtime to render to the specified output.

Builder step that instructs the runtime to render to the specified output.

This is a generic method based on Laika's IO model that concrete methods delegate to.

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def toFile(file: FilePath): Result

Builder step that instructs the runtime to render to the specified file.

Builder step that instructs the runtime to render to the specified file.

Value parameters

file

the file to write to

Attributes

Inherited from:
BinaryOutputOps
def toFile(name: String): Result

Builder step that instructs the runtime to render to the file with the specified name.

Builder step that instructs the runtime to render to the file with the specified name.

Value parameters

name

the name of the file to write to

Attributes

Inherited from:
BinaryOutputOps
def toStream(stream: F[OutputStream], autoClose: Boolean): Result

Builder step that instructs the runtime to render to the specified output stream.

Builder step that instructs the runtime to render to the specified output stream.

Value parameters

autoClose

indicates whether the stream should be closed after all output had been written

stream

the binary stream to render to

Attributes

Inherited from:
BinaryOutputOps

Deprecated and Inherited methods

def toFile(file: File): Result

Attributes

Deprecated
true
Inherited from:
BinaryOutputOps

Concrete fields

val F: Async[F]