W3cubDocs

/Kotlin

Package kotlin.native

Types

Platform and version requirements: Native (1.3)

BitSet

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

class BitSet
Platform and version requirements: Native (1.3)

CpuArchitecture

Central Processor Unit architecture.

enum class CpuArchitecture
Platform and version requirements: Native (1.3)

ImmutableBlob

An immutable compile-time array of bytes.

class ImmutableBlob
Platform and version requirements: Native (1.3)

IncorrectDereferenceException

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

class IncorrectDereferenceException : RuntimeException
Platform and version requirements: Native (1.3)

MemoryModel

Memory model.

enum class MemoryModel
Platform and version requirements: Native (1.3)

OsFamily

Operating system family.

enum class OsFamily
Platform and version requirements: Native (1.3)

Platform

Object describing the current platform program executes upon.

object Platform
Platform and version requirements: Native (1.3)

ReportUnhandledExceptionHook

Typealias describing custom exception reporting hook.

typealias ReportUnhandledExceptionHook = (Throwable) -> Unit
Platform and version requirements: Native (1.3)

Vector128

class Vector128

Annotations

Platform and version requirements: Native (1.3)

CName

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

annotation class CName
Platform and version requirements: Native (1.3)

Retain

Preserve the function entry point during global optimizations.

annotation class Retain
Platform and version requirements: Native (1.3)

RetainForTarget

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

annotation class RetainForTarget
Platform and version requirements: Native (1.3)

SymbolName

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

annotation class SymbolName

Functions

Platform and version requirements: Native (1.3)

asCPointer

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>
Platform and version requirements: Native (1.3)

asUCPointer

fun ImmutableBlob.asUCPointer(
    offset: Int = 0
): CPointer<UByteVar>
Platform and version requirements: Native (1.3)

deinitRuntimeIfNeeded

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

fun deinitRuntimeIfNeeded()
Platform and version requirements: Native (1.3)

getCharAt

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

fun ByteArray.getCharAt(index: Int): Char
Platform and version requirements: Native (1.3)

getDoubleAt

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

fun ByteArray.getDoubleAt(index: Int): Double
Platform and version requirements: Native (1.3)

getFloatAt

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

fun ByteArray.getFloatAt(index: Int): Float
Platform and version requirements: Native (1.3)

getIntAt

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

fun ByteArray.getIntAt(index: Int): Int
Platform and version requirements: Native (1.3)

getLongAt

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

fun ByteArray.getLongAt(index: Int): Long
Platform and version requirements: Native (1.3)

getShortAt

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

fun ByteArray.getShortAt(index: Int): Short
Platform and version requirements: Native (1.3)

getStackTraceAddresses

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

fun Throwable.getStackTraceAddresses(): List<Long>
Platform and version requirements: Native (1.3)

getUByteAt

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

fun ByteArray.getUByteAt(index: Int): UByte
Platform and version requirements: Native (1.3)

getUIntAt

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

fun ByteArray.getUIntAt(index: Int): UInt
Platform and version requirements: Native (1.3)

getULongAt

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

fun ByteArray.getULongAt(index: Int): ULong
Platform and version requirements: Native (1.3)

getUShortAt

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

fun ByteArray.getUShortAt(index: Int): UShort
Platform and version requirements: Native (1.3)

identityHashCode

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

fun Any?.identityHashCode(): Int
Platform and version requirements: Native (1.3)

immutableBlobOf

Creates ImmutableBlob out of compile-time constant data.

fun immutableBlobOf(vararg elements: Short): ImmutableBlob
Platform and version requirements: Native (1.3)

initRuntimeIfNeeded

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

fun initRuntimeIfNeeded()
Platform and version requirements: Native (1.3)

setCharAt

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

fun ByteArray.setCharAt(index: Int, value: Char)
Platform and version requirements: Native (1.3)

setDoubleAt

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

fun ByteArray.setDoubleAt(index: Int, value: Double)
Platform and version requirements: Native (1.3)

setFloatAt

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

fun ByteArray.setFloatAt(index: Int, value: Float)
Platform and version requirements: Native (1.3)

setIntAt

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

fun ByteArray.setIntAt(index: Int, value: Int)
Platform and version requirements: Native (1.3)

setLongAt

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

fun ByteArray.setLongAt(index: Int, value: Long)
Platform and version requirements: Native (1.3)

setShortAt

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

fun ByteArray.setShortAt(index: Int, value: Short)
Platform and version requirements: Native (1.3)

setUByteAt

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

fun ByteArray.setUByteAt(index: Int, value: UByte)
Platform and version requirements: Native (1.3)

setUIntAt

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

fun ByteArray.setUIntAt(index: Int, value: UInt)
Platform and version requirements: Native (1.3)

setULongAt

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

fun ByteArray.setULongAt(index: Int, value: ULong)
Platform and version requirements: Native (1.3)

setUnhandledExceptionHook

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?
Platform and version requirements: Native (1.3)

setUShortAt

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

fun ByteArray.setUShortAt(index: Int, value: UShort)
Platform and version requirements: Native (1.3)

stringFromUtf8

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
Platform and version requirements: Native (1.3)

stringFromUtf8OrThrow

Converts an UTF-8 array into a String.

fun ByteArray.stringFromUtf8OrThrow(): String
fun ByteArray.stringFromUtf8OrThrow(
    start: Int = 0, 
    size: Int = this.size
): String
Platform and version requirements: Native (1.3)

toByteArray

Copies the data from this blob into a new ByteArray.

fun ImmutableBlob.toByteArray(
    startIndex: Int = 0, 
    endIndex: Int = size
): ByteArray
Platform and version requirements: Native (1.3)

toUByteArray

Copies the data from this blob into a new UByteArray.

fun ImmutableBlob.toUByteArray(
    startIndex: Int = 0, 
    endIndex: Int = size
): UByteArray
Platform and version requirements: Native (1.3)

toUtf8

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
Platform and version requirements: Native (1.3)

toUtf8OrThrow

Converts a String into an UTF-8 array.

fun String.toUtf8OrThrow(): ByteArray
fun String.toUtf8OrThrow(
    start: Int = 0, 
    size: Int = this.length
): ByteArray
Platform and version requirements: Native (1.3)

vectorOf

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

© 2010–2020 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.native/index.html