kotlin-stdlib/kotlin.collections/component1

component1

inline operator fun <T> Array<out T>.component1(): T(source)
inline operator fun ByteArray.component1(): Byte(source)
inline operator fun ShortArray.component1(): Short(source)
inline operator fun IntArray.component1(): Int(source)
inline operator fun LongArray.component1(): Long(source)
inline operator fun FloatArray.component1(): Float(source)
inline operator fun DoubleArray.component1(): Double(source)
inline operator fun BooleanArray.component1(): Boolean(source)
inline operator fun CharArray.component1(): Char(source)

Returns 1st element from the array.

If the size of this array is less than 1, throws an IndexOutOfBoundsException except in Kotlin/JS where the behavior is unspecified, and in Kotlin/Wasm where a trap will be raised instead, unless -Xwasm-enable-array-range-checks compiler flag was specified when linking an executable.

Since Kotlin

1.0
inline operator fun <T> List<T>.component1(): T(source)

Returns 1st element from the list.

Throws an IndexOutOfBoundsException if the size of this list is less than 1.

Since Kotlin

1.0
@ExperimentalUnsignedTypes
inline operator fun UIntArray.component1(): UInt(source)
@ExperimentalUnsignedTypes
inline operator fun ULongArray.component1(): ULong(source)
@ExperimentalUnsignedTypes
inline operator fun UByteArray.component1(): UByte(source)
@ExperimentalUnsignedTypes
inline operator fun UShortArray.component1(): UShort(source)

Returns 1st element from the array.

If the size of this array is less than 1, throws an IndexOutOfBoundsException except in Kotlin/JS where the behavior is unspecified, and in Kotlin/Wasm where a trap will be raised instead, unless -Xwasm-enable-array-range-checks compiler flag was specified when linking an executable.

Since Kotlin

1.3
inline operator fun <K, V> Map.Entry<K, V>.component1(): K(source)

Returns the key component of the map entry.

This method allows to use destructuring declarations when working with maps, for example:

for ((key, value) in map) {
    // do something with the key and the value
}
Content copied to clipboard

Since Kotlin

1.0