OutputOps

case class OutputOps[F[_]](renderer: Renderer, theme: Theme[F], input: DocumentTreeRoot, staticDocuments: Seq[BinaryInput[F]])(implicit evidence$5: Sync[F], evidence$6: Batch[F]) extends TextOutputOps[F]

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

trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

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.

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

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product
def toDirectory(dir: File)(implicit codec: Codec): Result

Builder step that instructs the runtime to render the document tree to files in the specified directory and its subdirectories.

Builder step that instructs the runtime to render the document tree to files in the specified directory and its subdirectories.

The virtual paths of the document tree will be translated to a directory structure, with the root of the virtual path being the directory specified with this method.

Value Params
codec

the character encoding of the files, if not specified the platform default will be used.

dir

the directory to write to

Inherited from
TextOutputOps
def toDirectory(name: String)(implicit codec: Codec): Result

Builder step that instructs the runtime to render the document tree to files in the specified directory and its subdirectories.

Builder step that instructs the runtime to render the document tree to files in the specified directory and its subdirectories.

The virtual paths of the document tree will be translated to a directory structure, with the root of the virtual path being the directory specified with this method.

Value Params
codec

the character encoding of the files, if not specified the platform default will be used.

name

the name of the directory to write to

Inherited from
TextOutputOps
def toWorkingDirectory(implicit codec: Codec): Result

Builder step that instructs the runtime to render the document tree to files in the working directory and its subdirectories.

Builder step that instructs the runtime to render the document tree to files in the working directory and its subdirectories.

The virtual paths of the document tree will be translated to a directory structure, with the root of the virtual path being the directory specified with this method.

Value Params
codec

the character encoding of the files, if not specified the platform default will be used.

Inherited from
TextOutputOps

Concrete fields

val F: Sync[F]