materialize

fun materialize(result: RunResult, format: StandardReportFormat, reportsDir: Path, fileStem: String = DEFAULT_FILE_STEM, title: String? = null, sections: StandardReportMaterializer.SectionOptions = SectionOptions.DEFAULT): StandardReportOutcome(source)

Renders result's snapshot to format under reportsDir. Creates reportsDir (and its parents) if absent. The report file is named <fileStem>.<extension>.

Return

either the written file or a failure with cause.

Parameters

result

the terminal result whose snapshot is rendered. Must be Completed or BatchCompleted (with at least one snapshot); other states return StandardReportOutcome.Failed.

format

which renderer to invoke.

reportsDir

target directory; created lazily.

fileStem

filename without extension; defaults to DEFAULT_FILE_STEM.