runner-api/dev.ust.zinc.grader.pipeline/StageResult

StageResult

sealed class StageResult

The result of a pipeline stage.

The following table shows the allowed output-input combinations in a pipeline. "Default" refers to stage results which are neither DontCare or Undefined:

| Output \ Input | Default | DontCare | Undefined |  Any  |
|     Default    |    ==   |    OK    |   Error   | Error |
|    DontCare    |  Error  |   Error  |   Error   | Error |
|    Undefined   |  Error  |    OK    |   Error   | Error |
|       Any      |  Error  |    OK    |   Error   |   OK  |

Inheritors

Constructors

protected constructor()

Types

data class Any(val obj: Any?) : StageResult

StageResult indicating that the stage emits/accepts an object of a arbitrary type.

object DontCare : StageResult

StageResult indicating that the stage does not care about its input.

ExperimentalAnyResultType

annotation class ExperimentalAnyResultType

Annotation class marking StageResult.Any and its related methods as opt-in, because they are not intended for normal use.

data class HostPath(val hostPath: Path) : StageResult

object Undefined : StageResult

StageResult indicating that the stage does not output anything of meaningful value.

data class URL(val url: URL) : StageResult

data class Volume(val volume: EnvVolume) : StageResult

Functions

abstract fun asAnyResult(): StageResult.Any

Converts this into a StageResult.Any instance.

inline fun <OutT : StageResult> StageResult.castAs(): StageResult

Casts this into the stage result type of OutT, or throws IllegalArgumentException if the conversion is not possible.

fun StageResult.castTo(outClazz: KClass<out StageResult>): StageResult

Casts this into the stage result type of outClazz.