kotlin-stdlib/kotlin.io.encoding/Base64/encode

encode

fun encode(source: ByteArray, startIndex: Int = 0, endIndex: Int = source.size): String(source)

Encodes bytes from the specified source array or its subrange. Returns a string with the resulting symbols.

Whether the encoding result is padded with '=' depends on the PaddingOption set for this Base64 instance.

Use encodeToByteArray to get the output in ByteArray form.

Since Kotlin

1.8

Return

a string with the resulting symbols.

Parameters

source

the array to encode bytes from.

startIndex

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

endIndex

the end (exclusive) of the subrange to encode, size of the source array by default.

Throws

when startIndex or endIndex is out of range of source array indices.

when startIndex > endIndex.

Samples

import kotlin.io.encoding.*
import kotlin.test.*

fun main() { 
   //sampleStart 
   val data = byteArrayOf(-1, 0, -2, 0, -3)

val encoded = Base64.encode(data)
println(encoded) // /wD+AP0=

val encodedFromSubRange = Base64.encode(data, startIndex = 1, endIndex = 3)
println(encodedFromSubRange) // AP4= 
   //sampleEnd
}