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

AfterAllRenderingPeek

object AfterAllRenderingPeek : PeekPipelineStage<CharSequence>

Peek stage that runs after all rendering has been completed.

It usually matches with PipelineHooks.afterPostRendering.
If post-rendering is disabled by com.quarkdown.core.pipeline.PipelineOptions.wrapOutput set to false, it will match with PipelineHooks.afterRendering instead.

This stage allows for consistently hooking into the final rendered output, regardless of whether post-rendering is enabled or not.

Properties

open override val hook: KProperty1<PipelineHooks, Pipeline.(CharSequence) -> Unit>

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

Functions

open fun execute(input: CharSequence, data: SharedPipelineData): CharSequence

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

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

open override fun peek(input: CharSequence, data: SharedPipelineData)

Peeks at the input without modifying it.

open override fun process(input: CharSequence, data: SharedPipelineData): CharSequence

Processes the input by calling peek and then returning the input unchanged.

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.