laika-io
API
Generated with
laika-io/laika/laika.io/laika.io.api/TreeTransformer/OutputOps

OutputOps

laika.io.api.TreeTransformer$.OutputOps
case class OutputOps[F[_]](parsers: NonEmptyList[MarkupParser], renderer: Renderer, theme: Theme[F], input: InputTreeBuilder[F], mapper: TreeMapper[F])(implicit evidence$5: Async[F], evidence$6: Batch[F]) extends TextOutputOps[F]

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

Attributes

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

Members list

Type members

Types

type Result = Op[F]

Value members

Concrete methods

def toOutput(output: TreeOutput): Op[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.

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def toDirectory(dir: FilePath)(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 parameters

codec

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

dir

the directory to write to

Attributes

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 parameters

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

Attributes

Inherited from:
TextOutputOps

Deprecated and Inherited methods

def toDirectory(dir: File)(implicit codec: Codec): Result

Attributes

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

Attributes

Deprecated
true
Inherited from:
TextOutputOps

Concrete fields

val F: Sync[F]
Generated with