kotlin-stdlib/kotlin.native

Package kotlin.native

Types

BitSet

class BitSet(size: Int)

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

CName

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class CName(externName: String, shortName: String)

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

CpuArchitecture

enum CpuArchitecture : Enum<CpuArchitecture>

Central Processor Unit architecture.

ImmutableBlob

class ImmutableBlob

An immutable compile-time array of bytes.

IncorrectDereferenceException

class IncorrectDereferenceException : RuntimeException

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

MemoryModel

enum MemoryModel : Enum<MemoryModel>

Memory model.

OsFamily

enum OsFamily : Enum<OsFamily>

Operating system family.

Platform

object Platform

Object describing the current platform program executes upon.

ReportUnhandledExceptionHook

typealias ReportUnhandledExceptionHook = (Throwable) -> Unit

Typealias describing custom exception reporting hook.

Retain

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])

annotation class Retain

Preserve the function entry point during global optimizations.

RetainForTarget

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])

annotation class RetainForTarget(target: String)

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

SymbolName

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class SymbolName(name: String)

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

Vector128

class Vector128

Functions

asCPointer

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

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

asUCPointer

fun ImmutableBlob.asUCPointer(offset: Int = 0): CPointer<UByteVar>

deinitRuntimeIfNeeded

~~external~~ ~~fun~~ ~~deinitRuntimeIfNeeded~~()

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

getCharAt

external fun ByteArray.getCharAt(index: Int): Char

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

getDoubleAt

external fun ByteArray.getDoubleAt(index: Int): Double

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

getFloatAt

external fun ByteArray.getFloatAt(index: Int): Float

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

getIntAt

external fun ByteArray.getIntAt(index: Int): Int

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

getLongAt

external fun ByteArray.getLongAt(index: Int): Long

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

getShortAt

external fun ByteArray.getShortAt(index: Int): Short

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

getStackTraceAddresses

fun Throwable.getStackTraceAddresses(): List<Long>

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

getUByteAt

@ExperimentalUnsignedTypes

fun ByteArray.getUByteAt(index: Int): UByte

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

getUIntAt

@ExperimentalUnsignedTypes

external fun ByteArray.getUIntAt(index: Int): UInt

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

getULongAt

@ExperimentalUnsignedTypes

external fun ByteArray.getULongAt(index: Int): ULong

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

getUShortAt

@ExperimentalUnsignedTypes

external fun ByteArray.getUShortAt(index: Int): UShort

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

identityHashCode

external fun Any?.identityHashCode(): Int

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

immutableBlobOf

external fun immutableBlobOf(vararg elements: Short): ImmutableBlob

Creates ImmutableBlob out of compile-time constant data.

initRuntimeIfNeeded

external fun initRuntimeIfNeeded()

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

setCharAt

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

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

setDoubleAt

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

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

setFloatAt

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

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

setIntAt

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

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

setLongAt

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

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

setShortAt

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

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

setUByteAt

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

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

setUIntAt

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

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

setULongAt

@ExperimentalUnsignedTypes

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

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

setUnhandledExceptionHook

fun setUnhandledExceptionHook(hook: ReportUnhandledExceptionHook): ReportUnhandledExceptionHook?

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.

setUShortAt

@ExperimentalUnsignedTypes

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

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

toByteArray

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

Copies the data from this blob into a new ByteArray.

toUByteArray

@ExperimentalUnsignedTypes

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

Copies the data from this blob into a new UByteArray.

vectorOf

external fun vectorOf(f0: Float, f1: Float, f2: Float, f3: Float): Vector128

external fun vectorOf(f0: Int, f1: Int, f2: Int, f3: Int): Vector128