case class OutputOps[F[_]](renderer: Renderer, theme: Theme[F], input: DocumentTreeRoot, staticDocuments: Seq[BinaryInput[F]])(implicit evidence$5: Async[F], evidence$6: Batch[F]) extends TextOutputOps[F] with Product with Serializable
Builder step that allows to specify the output to render to.
- Alphabetic
- By Inheritance
- OutputOps
- Serializable
- Serializable
- Product
- Equals
- TextOutputOps
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new OutputOps(renderer: Renderer, theme: Theme[F], input: DocumentTreeRoot, staticDocuments: Seq[BinaryInput[F]])(implicit arg0: Async[F], arg1: Batch[F])
Type Members
-
type
Result = Op[F]
- Definition Classes
- OutputOps → TextOutputOps
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
F: Sync[F]
- Definition Classes
- OutputOps → TextOutputOps
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
def
copying(toCopy: Seq[BinaryInput[F]]): OutputOps[F]
Copies the specified binary input to the output target, in addition to rendering the document tree.
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val input: DocumentTreeRoot
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val renderer: Renderer
- val staticDocuments: Seq[BinaryInput[F]]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val theme: Theme[F]
-
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.
- dir
the directory to write to
- codec
the character encoding of the files, if not specified the platform default will be used.
- Definition Classes
- 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.
- name
the name of the directory to write to
- codec
the character encoding of the files, if not specified the platform default will be used.
- Definition Classes
- TextOutputOps
-
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.
- Definition Classes
- OutputOps → TextOutputOps
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated
-
def
toDirectory(dir: File)(implicit codec: Codec): Result
- Definition Classes
- TextOutputOps
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) use toDirectory(String) or toDirectory(FilePath)
-
def
toWorkingDirectory(implicit codec: Codec): Result
- Definition Classes
- TextOutputOps
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) use toDirectory(String) or toDirectory(FilePath) using a relative path