quarkdown-core/com.quarkdown.core.pipeline.stage/PipelineStage

PipelineStage

interface PipelineStage<I, O>

Represents a stage in the document processing pipeline.

Each pipeline stage takes an input of type I, processes it, and produces an output of type O. Pipeline stages can be chained together to form a complete processing pipeline.

Pipeline stages can also define hooks that are invoked after the stage completes processing, allowing for custom behavior to be executed at specific points in the pipeline.

Inheritors

PeekPipelineStage

AttachmentStage

LibrariesRegistrationStage

PostRenderingStage

ResourceGenerationStage

TreeRewriteStage

Properties

abstract val hook: (PipelineHooks) -> Pipeline.(O) -> Unit?

A hook function that is invoked after the stage completes processing.

Functions

open fun execute(input: I, data: SharedPipelineData): O

Executes this pipeline stage with the given input and shared data.

fun <O> PipelineStage<Unit, O>.execute(data: SharedPipelineData): O

Utility function to execute a pipeline stage that takes Unit as input.

open fun invokeHook(data: SharedPipelineData, input: I, output: O)

Invokes the hook function for this stage, if one is defined.

abstract fun process(input: I, data: SharedPipelineData): O

Processes the input I and produces an output O.

infix fun <A, B, C> PipelineStage<A, B>.then(next: PipelineStage<B, C>): PipelineStage<A, C>

Chains two pipeline stages together to form a new pipeline stage.

infix fun <A, B> PipelineStage<A, B>.thenOptionally(next: PipelineStage<B, B>?): PipelineStage<A, B>

Conditionally chains this pipeline stage with next if it is not null.