runtime-core/io.matthewnelson.kmp.tor.runtime.core/EnqueuedJob/State

State

enum State : Enum<EnqueuedJob.State> (source)

Entries

The initial state.

Point of no return where the job has been de-queued and is being executed. Cancellation will defer to the job's ExecutionPolicy. The next state transition will be to either Success or Error.

Cancelled

If the job completed by cancellation via cancel.

Success

If the job completed successfully via onCompletion.

Error

If the job completed exceptionally via onError.

Properties

entries

val entries: EnumEntries<EnqueuedJob.State>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): EnqueuedJob.State

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<EnqueuedJob.State>

Returns an array containing the constants of this enum type, in the order they're declared.