Packages

t

laika.io.ops

TextOutputOps

trait TextOutputOps[F[_]] extends AnyRef

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.

Linear Supertypes
AnyRef, Any
Known Subclasses
OutputOps, OutputOps
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TextOutputOps
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Result

Abstract Value Members

  1. abstract def F: Sync[F]
  2. abstract def toOutput(tree: TreeOutput): Result

    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 Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  15. 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.

  16. 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.

  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  2. def toDirectory(dir: File)(implicit codec: Codec): Result
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) use toDirectory(String) or toDirectory(FilePath)

  3. def toWorkingDirectory(implicit codec: Codec): Result
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) use toDirectory(String) or toDirectory(FilePath) using a relative path

Inherited from AnyRef

Inherited from Any

Ungrouped