kotlin-stdlib/kotlin.text/encodeToByteArray

encodeToByteArray

expect fun String.encodeToByteArray(): ByteArray(source)

Encodes this string to an array of bytes in UTF-8 encoding.

Any malformed char sequence is replaced by the replacement byte sequence.

Since Kotlin

1.4
expect fun String.encodeToByteArray(startIndex: Int = 0, endIndex: Int = this.length, throwOnInvalidSequence: Boolean = false): ByteArray(source)

Encodes this string or its substring to an array of bytes in UTF-8 encoding.

Since Kotlin

1.4

Parameters

startIndex

the beginning (inclusive) of the substring to encode, 0 by default.

endIndex

the end (exclusive) of the substring to encode, length of this string by default.

throwOnInvalidSequence

specifies whether to throw an exception on malformed char sequence or replace.

Throws

if startIndex is less than zero or endIndex is greater than the length of this string.

if startIndex is greater than endIndex.

if this string contains malformed char sequence and throwOnInvalidSequence is true.

actual fun String.encodeToByteArray(): ByteArray(source)

Encodes this string to an array of bytes in UTF-8 encoding.

Any malformed char sequence is replaced by the replacement byte sequence.

Since Kotlin

1.4
actual fun String.encodeToByteArray(startIndex: Int = 0, endIndex: Int = this.length, throwOnInvalidSequence: Boolean = false): ByteArray(source)

Encodes this string or its substring to an array of bytes in UTF-8 encoding.

Since Kotlin

1.4

Parameters

startIndex

the beginning (inclusive) of the substring to encode, 0 by default.

endIndex

the end (exclusive) of the substring to encode, length of this string by default.

throwOnInvalidSequence

specifies whether to throw an exception on malformed char sequence or replace.

Throws

if startIndex is less than zero or endIndex is greater than the length of this string.

if startIndex is greater than endIndex.

if this string contains malformed char sequence and throwOnInvalidSequence is true.

actual fun String.encodeToByteArray(): ByteArray(source)

Encodes this string to an array of bytes in UTF-8 encoding.

Any malformed char sequence is replaced by the replacement byte sequence.

Since Kotlin

1.4
actual fun String.encodeToByteArray(startIndex: Int = 0, endIndex: Int = this.length, throwOnInvalidSequence: Boolean = false): ByteArray(source)

Encodes this string or its substring to an array of bytes in UTF-8 encoding.

Since Kotlin

1.4

Parameters

startIndex

the beginning (inclusive) of the substring to encode, 0 by default.

endIndex

the end (exclusive) of the substring to encode, length of this string by default.

throwOnInvalidSequence

specifies whether to throw an exception on malformed char sequence or replace.

Throws

if startIndex is less than zero or endIndex is greater than the length of this string.

if startIndex is greater than endIndex.

if this string contains malformed char sequence and throwOnInvalidSequence is true.

actual fun String.encodeToByteArray(): ByteArray(source)

Encodes this string to an array of bytes in UTF-8 encoding.

Any malformed char sequence is replaced by the replacement byte sequence.

Since Kotlin

1.3
actual fun String.encodeToByteArray(startIndex: Int = 0, endIndex: Int = this.length, throwOnInvalidSequence: Boolean = false): ByteArray(source)

Encodes this string or its substring to an array of bytes in UTF-8 encoding.

Since Kotlin

1.3

Parameters

startIndex

the beginning (inclusive) of the substring to encode, 0 by default.

endIndex

the end (exclusive) of the substring to encode, length of this string by default.

throwOnInvalidSequence

specifies whether to throw an exception on malformed char sequence or replace.

Throws

if startIndex is less than zero or endIndex is greater than the length of this string.

if startIndex is greater than endIndex.

if this string contains malformed char sequence and throwOnInvalidSequence is true.