TextOutputOps

trait TextOutputOps[F[_]]

API for specifying the tree of character outputs for a rendering operation.

It allows any class merging in this trait to define all input related operations in terms of the only abstract method toOutput.

class Object
trait Matchable
class Any
class OutputOps[F]
class OutputOps[F]

Type members

Types

type Result

Value members

Abstract methods

def F: Sync[F]

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

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

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

Concrete methods

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

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

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.