case class BinaryInput[F[_]](input: Stream[F, Byte], path: Path, formats: TargetFormats = TargetFormats.All, sourceFile: Option[FilePath] = None)(implicit evidence$1: Sync[F]) extends Navigatable with Product with Serializable
A binary input stream and its virtual path within the input tree.
- 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.- 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)
- sourceFile
The source file from the file system, empty if this does not represent a file system resource
- Alphabetic
- By Inheritance
- BinaryInput
- Serializable
- Serializable
- Product
- Equals
- Navigatable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
BinaryInput(input: Stream[F, Byte], path: Path, formats: TargetFormats = TargetFormats.All, sourceFile: Option[FilePath] = None)(implicit arg0: Sync[F])
- 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.- 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)
- sourceFile
The source file from the file system, empty if this does not represent a file system resource
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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val formats: TargetFormats
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val input: Stream[F, Byte]
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
lazy val
name: String
The local name of this navigatable.
The local name of this navigatable.
- Definition Classes
- Navigatable
-
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
path: Path
- Definition Classes
- BinaryInput → Navigatable
- val sourceFile: Option[FilePath]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
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