Packages

t

laika.io.ops

BinaryOutputOps

trait BinaryOutputOps[F[_]] extends AnyRef

API for specifying the output for a binary format like EPUB or PDF.

It allows any class merging in this trait to define all output 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. BinaryOutputOps
  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: Async[F]
  2. abstract def toOutput(output: BinaryOutput[F]): Result

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

    Builder step that instructs the runtime to render to the specified 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 toFile(file: FilePath): Result

    Builder step that instructs the runtime to render to the specified file.

    Builder step that instructs the runtime to render to the specified file.

    file

    the file to write to

  16. def toFile(name: String): Result

    Builder step that instructs the runtime to render to the file with the specified name.

    Builder step that instructs the runtime to render to the file with the specified name.

    name

    the name of the file to write to

  17. def toStream(stream: F[OutputStream], autoClose: Boolean = true): Result

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

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

    stream

    the binary stream to render to

    autoClose

    indicates whether the stream should be closed after all output had been written

  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. 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 toFile(file: File): Result
    Annotations
    @deprecated
    Deprecated

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

Inherited from AnyRef

Inherited from Any

Ungrouped