kotlin-stdlib/kotlin.native

Package-level declarations

Provides functions and types specific to Kotlin/Native, as well as means for interoperability with an underlying platform and other languages.

Provides functions and types specific to Kotlin/Native, as well as means for interoperability with an underlying platform and other languages.

Provides functions and types specific to Kotlin/Native, as well as means for interoperability with an underlying platform and other languages.

Provides functions and types specific to Kotlin/Native, as well as means for interoperability with an underlying platform and other languages.

Types

Link copied to clipboard
@ObsoleteNativeApi
actual class BitSet(size: Int = ELEMENT_SIZE)

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
@Target(allowedTargets = [AnnotationTarget.FUNCTION])
expect annotation class CName(val externName: String = "", val shortName: String = "")

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

Since Kotlin 1.5
@ExperimentalNativeApi
@Target(allowedTargets = [AnnotationTarget.FUNCTION])
actual annotation class CName(val externName: String = "", val shortName: String = "")

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
enum CpuArchitecture : Enum<CpuArchitecture>

Central Processor Unit architecture.

Since Kotlin 1.3
Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.PROPERTY])
@ExperimentalStdlibApi
annotation class EagerInitialization

Forces a top-level property to be initialized eagerly, opposed to lazily on the first access to file and/or property. This annotation can be used as temporal migration assistance during the transition from the previous Kotlin/Native initialization scheme "eager by default" to the new one, "lazy by default".

Since Kotlin 1.3
Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])
expect annotation class FreezingIsDeprecated

Freezing API has been deprecated since Kotlin 1.7.20, and support for the legacy memory manager was completely removed from the compiler in 1.9.20.

Since Kotlin 1.7
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])
actual annotation class FreezingIsDeprecated

Freezing API has been deprecated since Kotlin 1.7.20, and support for the legacy memory manager was completely removed from the compiler in 1.9.20.

Since Kotlin 1.7
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])
actual annotation class FreezingIsDeprecated

Freezing API has been deprecated since Kotlin 1.7.20, and support for the legacy memory manager was completely removed from the compiler in 1.9.20.

Since Kotlin 1.8
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])
actual annotation class FreezingIsDeprecated

Freezing API has been deprecated since Kotlin 1.7.20, and support for the legacy memory manager was completely removed from the compiler in 1.9.20.

Since Kotlin 1.8
Link copied to clipboard
@HidesFromObjC
@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])
@ExperimentalObjCRefinement
expect annotation class HiddenFromObjC

Instructs the Kotlin compiler to remove this class, function or property from the public Objective-C API.

Since Kotlin 1.8
@HidesFromObjC
@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])
@ExperimentalObjCRefinement
actual annotation class HiddenFromObjC

Instructs the Kotlin compiler to remove this class, function or property from the public Objective-C API.

Since Kotlin 1.8
Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS])
@ExperimentalObjCRefinement
expect annotation class HidesFromObjC

Meta-annotation that instructs the Kotlin compiler to remove the annotated class, function or property from the public Objective-C API.

Since Kotlin 1.8
@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS])
@ExperimentalObjCRefinement
actual annotation class HidesFromObjC

Meta-annotation that instructs the Kotlin compiler to remove the annotated class, function or property from the public Objective-C API.

Since Kotlin 1.8
Link copied to clipboard
class ImmutableBlob

An immutable compile-time array of bytes.

Since Kotlin 1.3
Link copied to clipboard
class IncorrectDereferenceException : RuntimeException

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
enum MemoryModel : Enum<MemoryModel>

Memory model.

Since Kotlin 1.3
Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FUNCTION])
@ExperimentalObjCName
expect annotation class ObjCName(val name: String = "", val swiftName: String = "", val exact: Boolean = false)

Instructs the Kotlin compiler to use a custom Objective-C and/or Swift name for this class, property, parameter or function.

Since Kotlin 1.8
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FUNCTION])
@ExperimentalObjCName
actual annotation class ObjCName(val name: String = "", val swiftName: String = "", val exact: Boolean = false)

Instructs the Kotlin compiler to use a custom Objective-C and/or Swift name for this class, property, parameter or function.

Since Kotlin 1.8
Link copied to clipboard
Link copied to clipboard
@ExperimentalNativeApi
enum OsFamily : Enum<OsFamily>

Operating system family.

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
object Platform

Object describing the current platform program executes upon.

Since Kotlin 1.3
Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS])
@ExperimentalObjCRefinement
expect annotation class RefinesInSwift

Meta-annotation that instructs the Kotlin compiler to mark the annotated function or property as swift_private in the generated Objective-C API.

Since Kotlin 1.8
@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS])
@ExperimentalObjCRefinement
actual annotation class RefinesInSwift

Meta-annotation that instructs the Kotlin compiler to mark the annotated function or property as swift_private in the generated Objective-C API.

Since Kotlin 1.8
Link copied to clipboard
@ExperimentalNativeApi
typealias ReportUnhandledExceptionHook = (Throwable) -> Unit

Typealias describing custom exception reporting hook.

Since Kotlin 1.3
Link copied to clipboard
@RefinesInSwift
@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION])
@ExperimentalObjCRefinement
expect annotation class ShouldRefineInSwift

Instructs the Kotlin compiler to mark this function or property as swift_private in the generated Objective-C API.

Since Kotlin 1.8
@RefinesInSwift
@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION])
@ExperimentalObjCRefinement
actual annotation class ShouldRefineInSwift

Instructs the Kotlin compiler to mark this function or property as swift_private in the generated Objective-C API.

Since Kotlin 1.8
Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class SymbolName(val name: String)

This is a dangerous deprecated and internal annotation. Please avoid using it.

Since Kotlin 1.3
Link copied to clipboard
typealias Vector128 = kotlinx.cinterop.Vector128
Since Kotlin 1.3

Functions

Link copied to clipboard
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.

Since Kotlin 1.3
Link copied to clipboard
fun ImmutableBlob.asUCPointer(offset: Int = 0): CPointer<UByteVar>

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun ByteArray.getCharAt(index: Int): Char

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun ByteArray.getDoubleAt(index: Int): Double

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun ByteArray.getFloatAt(index: Int): Float

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun ByteArray.getIntAt(index: Int): Int

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun ByteArray.getLongAt(index: Int): Long

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun ByteArray.getShortAt(index: Int): Short

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
fun Throwable.getStackTraceAddresses(): List<Long>

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
fun ByteArray.getUByteAt(index: Int): UByte

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
@ExperimentalUnsignedTypes
external fun ByteArray.getUIntAt(index: Int): UInt

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
@ExperimentalUnsignedTypes
external fun ByteArray.getULongAt(index: Int): ULong

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
fun getUnhandledExceptionHook(): ReportUnhandledExceptionHook?

Returns a user-defined unhandled exception hook set by setUnhandledExceptionHook or null if no user-defined hooks were set.

Since Kotlin 1.6
Link copied to clipboard
@ExperimentalNativeApi
@ExperimentalUnsignedTypes
external fun ByteArray.getUShortAt(index: Int): UShort

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun Any?.identityHashCode(): Int

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

Since Kotlin 1.3
Link copied to clipboard
external fun immutableBlobOf(vararg elements: Short): ImmutableBlob

Creates ImmutableBlob out of compile-time constant data.

Since Kotlin 1.3
Link copied to clipboard
fun initRuntimeIfNeeded()

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalStdlibApi
fun isExperimentalMM(): Boolean
Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun processUnhandledException(throwable: Throwable)

Performs the default processing of unhandled exception.

Since Kotlin 1.6
Link copied to clipboard
@ExperimentalNativeApi
external fun ByteArray.setCharAt(index: Int, value: Char)

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun ByteArray.setDoubleAt(index: Int, value: Double)

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun ByteArray.setFloatAt(index: Int, value: Float)

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun ByteArray.setIntAt(index: Int, value: Int)

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun ByteArray.setLongAt(index: Int, value: Long)

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun ByteArray.setShortAt(index: Int, value: Short)

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun ByteArray.setUByteAt(index: Int, value: UByte)

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun ByteArray.setUIntAt(index: Int, value: UInt)

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
@ExperimentalUnsignedTypes
external fun ByteArray.setULongAt(index: Int, value: ULong)

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
fun setUnhandledExceptionHook(hook: ReportUnhandledExceptionHook?): ReportUnhandledExceptionHook?

Installs an unhandled exception hook and returns an old hook, or null if no user-defined hooks were previously set.

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
@ExperimentalUnsignedTypes
external fun ByteArray.setUShortAt(index: Int, value: UShort)

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

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalNativeApi
external fun terminateWithUnhandledException(throwable: Throwable): Nothing
Since Kotlin 1.6
Link copied to clipboard
external fun ImmutableBlob.toByteArray(startIndex: Int = 0, endIndex: Int = size): ByteArray

Copies the data from this blob into a new ByteArray.

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalUnsignedTypes
external fun ImmutableBlob.toUByteArray(startIndex: Int = 0, endIndex: Int = size): UByteArray

Copies the data from this blob into a new UByteArray.

Since Kotlin 1.3
Link copied to clipboard
external fun vectorOf(f0: Float, f1: Float, f2: Float, f3: Float): Vector128
external fun vectorOf(f0: Int, f1: Int, f2: Int, f3: Int): Vector128
Since Kotlin 1.3