report

abstract fun report(fraction: Float?, phase: String? = null)

Reports how far this scope's window is done.

Report in coarse steps, such as per page or per percent, not per byte. Each new value allocates a Progress and wakes the collectors. This function never throws.

Parameters

fraction

the done part of this window, from 0f to 1f, not a percent. null means indeterminate. A value outside 0..1 is clamped.

phase

a new label for the current step, or null to keep the current label.


abstract fun report(done: Long, total: Long, phase: String? = null)

Reports done of total units, for example report(done = 3, total = 10) for 30%.

Parameters

total

the unit count. Zero or less means indeterminate, for a total that is not known yet.

phase

a new label for the current step, or null to keep the current label.