quarkdown-core/com.quarkdown.core.pipeline.stages/AttachmentStage

AttachmentStage

object AttachmentStage : PipelineStage<Unit, Boolean>

Pipeline stage responsible for attaching a pipeline to the document context.

This stage takes no specific input (Unit) and produces a Boolean output indicating whether the attachment processing was successfully created if it was missing.

In case the context is a scope context (e.g. for subdocuments), the pipeline will likely already be attached from the parent context. In this case, the output will be false, and hooks won't be invoked.

Properties

open override val hook: Nothing? = null

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

Functions

open fun execute(input: Unit, data: SharedPipelineData): Boolean

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: Unit, output: Boolean)

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

open override fun process(input: Unit, data: SharedPipelineData): Boolean

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.