ProgressReporter

fun interface ProgressReporter(source)

SAM interface to communicate progress to a caller.

Instances of this interface can be created by a caller and passed to a downstream user. The downstream user can then call the report function to communicate its progress to the caller.

If you are attempting to call a function which requires an instance of ProgressReporter, but you do not care about the progress events, you can use emptyProgressReporter to access a no-op implementation.

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard

Creates a new reporter that applies transform to each progress event it receives.

Link copied to clipboard
fun ProgressReporter.reduceToInterval(interval: ClosedFloatingPointRange<Double>, treatDoneAs: Progress.Loading.Quantified = defaultDone, treatUnquantifiedAs: Progress.Loading.Quantified = defaultUnquantified): ProgressReporter

Creates a new reporter that proportionally confines progress events to interval.

fun ProgressReporter.reduceToInterval(min: Double, max: Double, treatDoneAs: Progress.Loading.Quantified = defaultDone, treatUnquantifiedAs: Progress.Loading.Quantified = defaultUnquantified): ProgressReporter

Creates a new reporter that proportionally confines progress events to the min..max range.

Link copied to clipboard
abstract fun report(progress: Progress)

Reports that the current task has reached progress.