kotlin-stdlib / kotlin.text / decodeToString

decodeToString

Common
JVM
JS
1.3
@ExperimentalStdlibApi fun ByteArray.decodeToString(): String
Native
1.3
fun ByteArray.decodeToString(): String

Decodes a string from the bytes in UTF-8 encoding in this array.

Malformed byte sequences are replaced by the replacement char \uFFFD.

Common
JVM
JS
1.3
@ExperimentalStdlibApi fun ByteArray.decodeToString(
    startIndex: Int = 0,
    endIndex: Int = this.size,
    throwOnInvalidSequence: Boolean = false
): String
Native
1.3
fun ByteArray.decodeToString(
    startIndex: Int,
    endIndex: Int,
    throwOnInvalidSequence: Boolean
): String

Decodes a string from the bytes in UTF-8 encoding in this array or its subrange.

Parameters

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

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

throwOnInvalidSequence - specifies whether to throw an exception on malformed byte sequence or replace it by the replacement char \uFFFD.

Exceptions

IndexOutOfBoundsException - if startIndex is less than zero or endIndex is greater than the size of this array.

IllegalArgumentException - if startIndex is greater than endIndex.

CharacterCodingException - if the byte array contains malformed UTF-8 byte sequence and throwOnInvalidSequence is true.