quarkdown-core/com.quarkdown.core.pipeline.output

Package-level declarations

Types

Possible types of content an OutputArtifact contains.

data class BinaryOutputArtifact(val name: String, val content: List<Byte>, val type: ArtifactType) : OutputArtifact<List<Byte>>

Represents an OutputResource that contains binary data.

FileReferenceOutputArtifact

data class FileReferenceOutputArtifact(val name: String, val file: FsEntry, val useChecksumInvalidation: Boolean = false, val symlink: Boolean = false) : OutputResource

An OutputResource backed by a filesystem entry. Instead of holding content in memory, it references a file that the exporter reads from directly: disk-backed entries are efficiently copied (or symlinked) by reference, while virtual entries are materialized on the fly.

LazyOutputArtifact

data class LazyOutputArtifact(val name: String, val content: () -> List<Byte>, val type: ArtifactType) : OutputArtifact<() -> List<Byte>>

Represents a BinaryOutputArtifact whose content is lazily loaded on demand (via accept).

OutputArtifact

interface OutputArtifact<T> : OutputResource

Represents an OutputResource that contains data. When visited by a FileResourceExporter, this resource is exported to a file whose extension is determined by the resource's type.

OutputResource

interface OutputResource

Abstraction of an output entity produced by the pipeline. A resource is saved to file via a com.quarkdown.core.pipeline.output.visitor.FileResourceExporter.

OutputResourceGroup

data class OutputResourceGroup(val name: String, val resources: Set<OutputResource>) : OutputResource

Represents an OutputResource that contains other resources (and does not provide content of its own). When visited by a FileResourceExporter, this resource is exported to a directory.

OutputResourceNaming

object OutputResourceNaming

Mapping of OutputResources to their file names, shared by every exporter.

OutputResourceVisitor

interface OutputResourceVisitor<T>

Visitor for OutputResource types.

TextOutputArtifact

data class TextOutputArtifact(val name: String, val content: CharSequence, val type: ArtifactType) : OutputArtifact<CharSequence>

Represents an OutputResource that contains text data.

Functions

toOutputResource

fun FsEntry.toOutputResource(name: String = this.name, useChecksumInvalidation: Boolean = false, symlink: Boolean = false): OutputResource

Converts this entry to an OutputResource for the pipeline to output.