Progress/opensavvy.progress

Package-level declarations

The Progress interface hierarchy.

Overview

When storing progress events:

Progress represents both finished and ongoing tasks,
Progress.Done represents finished tasks,
Progress.Loading represents ongoing tasks,
Progress.Loading.Unquantified represents ongoing tasks for which no more information is available,
Progress.Loading.Quantified represents ongoing tasks for which some information is available.

When reporting events, most of the code should use the done and the loading helpers.

sealed interface Progress

Is work currently happening?

data class Progressive<out Value>(val value: Value, val progress: Progress)

Stores a value along with progress information.

All scheduled work for this task has been done.

Some scheduled work is ongoing, but we have no information on how much is left.

Some scheduled work is ongoing, and we can estimate the ratio of what has been done compared to what's left to do.