BinaryInput

laika.io.model.BinaryInput
See theBinaryInput companion object
case class BinaryInput[F[_]](input: Stream[F, Byte], path: Path, formats: TargetFormats, sourceFile: Option[FilePath])(implicit evidence$1: Sync[F]) extends Navigatable

A binary input stream and its virtual path within the input tree.

Value parameters

formats

Indicates the output formats this binary input should be included in; by default binary resources are included in all output formats, but it can be restricted if necessary (e.g. to only include it in HTML output, but omit it from PDF or EPUB)

input

The binary input

path

The full virtual path of this input (does not represent the filesystem path in case of file I/O), the point within the virtual tree of inputs (usually a DocumentTree) this resource should be linked into.

sourceFile

The source file from the file system, empty if this does not represent a file system resource

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Navigatable
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product

Inherited fields

lazy val name: String

The local name of this navigatable.

The local name of this navigatable.

Attributes

Inherited from:
Navigatable