KiteCore/io.github.yuroyami.kitecore/PlatformFamily

PlatformFamily

enum class PlatformFamily : Enum<PlatformFamily>

The kind of platform the code runs on, for when branches in common code.

Read it from Platform.family. Branch on this enum, never on the strings of Platform.

Entries

An Android app or library, on a device or an emulator.

A desktop or server JVM. Android is ANDROID, not JVM.

iOS, on a device or the simulator.

macOS, as a Kotlin/Native target. A JVM on a Mac is JVM.

Kotlin/JS, in a browser or in Node.

Kotlin/Wasm (wasmJs), in a browser or in Node.

An Apple OS other than iOS and macOS. No target that KiteCore builds today returns it, so keep an OTHER or else branch for targets added later.

Companion properties

val entries: EnumEntries<PlatformFamily>

Returns an immutable kotlin.enums.EnumEntries list containing the constants of this enum type, in the order they're declared.

Companion functions

fun valueOf(value: String): PlatformFamily

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.)

fun values(): Array<PlatformFamily>

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

Properties

val name: String

val ordinal: Int