Package kotlin.native

A vector of bits growing if necessary and allowing one to set/clear/read bits from it by a bit index.

class BitSet

Central Processor Unit architecture.

enum class CpuArchitecture

An immutable compile-time array of bytes.

class ImmutableBlob

Exception thrown when top level variable is accessed from incorrect execution context.

class IncorrectDereferenceException : RuntimeException

Memory model.

enum class MemoryModel

Operating system family.

enum class OsFamily

Object describing the current platform program executes upon.

object Platform

Typealias describing custom exception reporting hook.

typealias ReportUnhandledExceptionHook = (Throwable) -> Unit

Makes top level function available from C/C++ code with the given name.

annotation class CName

Preserve the function entry point during global optimizations.

annotation class Retain

Preserve the function entry point during global optimizations, only for the given target.

annotation class RetainForTarget

Forces the compiler to use specified symbol name for the target external function.

annotation class SymbolName

Returns stable C pointer to data at certain offset, useful as a way to pass resource to C APIs.

fun ImmutableBlob.asCPointer(
    offset: Int = 0
): CPointer<ByteVar>

Deinitializes Kotlin runtime for the current thread, if was inited. Cannot be called from Kotlin frames holding references, thus deprecated.

fun deinitRuntimeIfNeeded()

Gets Char out of the ByteArray byte buffer at specified index index

fun ByteArray.getCharAt(index: Int): Char

Gets Double out of the ByteArray byte buffer at specified index index

fun ByteArray.getDoubleAt(index: Int): Double

Gets Float out of the ByteArray byte buffer at specified index index

fun ByteArray.getFloatAt(index: Int): Float

Gets Int out of the ByteArray byte buffer at specified index index

fun ByteArray.getIntAt(index: Int): Int

Gets Long out of the ByteArray byte buffer at specified index index

fun ByteArray.getLongAt(index: Int): Long

Gets Short out of the ByteArray byte buffer at specified index index

fun ByteArray.getShortAt(index: Int): Short

Returns a list of stack trace addresses representing the stack trace pertaining to this throwable.

fun Throwable.getStackTraceAddresses(): List<Long>

Gets UByte out of the ByteArray byte buffer at specified index index

fun ByteArray.getUByteAt(index: Int): UByte

Gets UInt out of the ByteArray byte buffer at specified index index

fun ByteArray.getUIntAt(index: Int): UInt

Gets ULong out of the ByteArray byte buffer at specified index index

fun ByteArray.getULongAt(index: Int): ULong

Gets UShort out of the ByteArray byte buffer at specified index index

fun ByteArray.getUShortAt(index: Int): UShort

Compute stable wrt potential object relocations by the memory manager identity hash code.

fun Any?.identityHashCode(): Int

Creates ImmutableBlob out of compile-time constant data.

fun immutableBlobOf(vararg elements: Short): ImmutableBlob

Initializes Kotlin runtime for the current thread, if not inited already.

fun initRuntimeIfNeeded()

Sets Char out of the ByteArray byte buffer at specified index index

fun ByteArray.setCharAt(index: Int, value: Char)

Sets Double out of the ByteArray byte buffer at specified index index

fun ByteArray.setDoubleAt(index: Int, value: Double)

Sets Float out of the ByteArray byte buffer at specified index index

fun ByteArray.setFloatAt(index: Int, value: Float)

Sets Int out of the ByteArray byte buffer at specified index index

fun ByteArray.setIntAt(index: Int, value: Int)

Sets Long out of the ByteArray byte buffer at specified index index

fun ByteArray.setLongAt(index: Int, value: Long)

Sets Short out of the ByteArray byte buffer at specified index index

fun ByteArray.setShortAt(index: Int, value: Short)

Sets UByte out of the ByteArray byte buffer at specified index index

fun ByteArray.setUByteAt(index: Int, value: UByte)

Sets UInt out of the ByteArray byte buffer at specified index index

fun ByteArray.setUIntAt(index: Int, value: UInt)

Sets ULong out of the ByteArray byte buffer at specified index index

fun ByteArray.setULongAt(index: Int, value: ULong)

Install custom unhandled exception hook. Returns old hook, or null if it was not specified. Hook is invoked whenever there's uncaught exception reaching boundaries of the Kotlin world, i.e. top level main(), or when Objective-C to Kotlin call not marked with @Throws throws an exception. Hook must be a frozen lambda, so that it could be called from any thread/worker. Hook is invoked once, and is cleared afterwards, so that memory leak detection works as expected even with custom exception hooks.

fun setUnhandledExceptionHook(
    hook: ReportUnhandledExceptionHook
): ReportUnhandledExceptionHook?

Sets UShort out of the ByteArray byte buffer at specified index index

fun ByteArray.setUShortAt(index: Int, value: UShort)

Converts an UTF-8 array into a String. Replaces invalid input sequences with a default character.

fun ByteArray.stringFromUtf8(): String

fun ByteArray.stringFromUtf8(
    start: Int = 0, 
    size: Int = this.size
): String

Converts an UTF-8 array into a String.

fun ByteArray.stringFromUtf8OrThrow(): String

fun ByteArray.stringFromUtf8OrThrow(
    start: Int = 0, 
    size: Int = this.size
): String

Copies the data from this blob into a new ByteArray.

fun ImmutableBlob.toByteArray(
    startIndex: Int = 0, 
    endIndex: Int = size
): ByteArray

Copies the data from this blob into a new UByteArray.

fun ImmutableBlob.toUByteArray(
    startIndex: Int = 0, 
    endIndex: Int = size
): UByteArray

Converts a String into an UTF-8 array. Replaces invalid input sequences with a default character.

fun String.toUtf8(): ByteArray

fun String.toUtf8(
    start: Int = 0, 
    size: Int = this.length
): ByteArray

Converts a String into an UTF-8 array.

fun String.toUtf8OrThrow(): ByteArray

fun String.toUtf8OrThrow(
    start: Int = 0, 
    size: Int = this.length
): ByteArray