kotlin-stdlib / kotlin.collections / copyInto

copyInto

Common

JVM

Native

1.3

fun <T> Array<out T>.copyInto(
    destination: Array<T>, 
    destinationOffset: Int = 0, 
    startIndex: Int = 0, 
    endIndex: Int = size
): Array<T>

fun ByteArray.copyInto(
    destination: ByteArray, 
    destinationOffset: Int = 0, 
    startIndex: Int = 0, 
    endIndex: Int = size
): ByteArray

fun ShortArray.copyInto(
    destination: ShortArray, 
    destinationOffset: Int = 0, 
    startIndex: Int = 0, 
    endIndex: Int = size
): ShortArray

fun IntArray.copyInto(
    destination: IntArray, 
    destinationOffset: Int = 0, 
    startIndex: Int = 0, 
    endIndex: Int = size
): IntArray

fun LongArray.copyInto(
    destination: LongArray, 
    destinationOffset: Int = 0, 
    startIndex: Int = 0, 
    endIndex: Int = size
): LongArray

fun FloatArray.copyInto(
    destination: FloatArray, 
    destinationOffset: Int = 0, 
    startIndex: Int = 0, 
    endIndex: Int = size
): FloatArray

fun DoubleArray.copyInto(
    destination: DoubleArray, 
    destinationOffset: Int = 0, 
    startIndex: Int = 0, 
    endIndex: Int = size
): DoubleArray

fun BooleanArray.copyInto(
    destination: BooleanArray, 
    destinationOffset: Int = 0, 
    startIndex: Int = 0, 
    endIndex: Int = size
): BooleanArray

fun CharArray.copyInto(
    destination: CharArray, 
    destinationOffset: Int = 0, 
    startIndex: Int = 0, 
    endIndex: Int = size
): CharArray

Copies this array or its subrange into the destination array and returns that array.

It's allowed to pass the same array in the destination and even specify the subrange so that it overlaps with the destination range.

Parameters

destination - the array to copy to.

destinationOffset - the position in the destination array to copy to, 0 by default.

startIndex - the beginning (inclusive) of the subrange to copy, 0 by default.

endIndex - the end (exclusive) of the subrange to copy, size of this array by default.

Exceptions

IndexOutOfBoundsException - or IllegalArgumentException when startIndex or endIndex is out of range of this array indices or when startIndex > endIndex.

IndexOutOfBoundsException - when the subrange doesn't fit into the destination array starting at the specified destinationOffset, or when that index is out of the destination array indices range.

Return the destination array.