kotlin-stdlib/kotlin.io.encoding/Base64

Base64

@ExperimentalEncodingApi
open class Base64(source)

Provides Base64 encoding and decoding functionality.

This class is not supposed to be instantiated or inherited. However, predefined instances of this class are available for use. The companion object Base64.Default is the default instance of Base64. There are also Base64.UrlSafe and Base64.Mime instances.

Since Kotlin

1.8

Inheritors

Types

Link copied to clipboard
object Default : Base64

The "base64" encoding specified by RFC 4648 section 4, Base 64 Encoding.

Since Kotlin 1.8

Functions

Link copied to clipboard
fun decode(source: ByteArray, startIndex: Int = 0, endIndex: Int = source.size): ByteArray

Decodes symbols from the specified source array or its subrange. Returns a ByteArray containing the resulting bytes.

Since Kotlin 1.8
fun decode(source: CharSequence, startIndex: Int = 0, endIndex: Int = source.length): ByteArray

Decodes symbols from the specified source char sequence or its substring. Returns a ByteArray containing the resulting bytes.

Since Kotlin 1.8
Link copied to clipboard
fun decodeIntoByteArray(source: ByteArray, destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = source.size): Int

Decodes symbols from the specified source array or its subrange and writes resulting bytes into the destination array. Returns the number of bytes written.

Since Kotlin 1.8
fun decodeIntoByteArray(source: CharSequence, destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = source.length): Int

Decodes symbols from the specified source char sequence or its substring and writes resulting bytes into the destination array. Returns the number of bytes written.

Since Kotlin 1.8
Link copied to clipboard
fun encode(source: ByteArray, startIndex: Int = 0, endIndex: Int = source.size): String

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

Since Kotlin 1.8
Link copied to clipboard
fun encodeIntoByteArray(source: ByteArray, destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = source.size): Int

Encodes bytes from the specified source array or its subrange and writes resulting symbols into the destination array. Returns the number of symbols written.

Since Kotlin 1.8
Link copied to clipboard
fun <A : Appendable> encodeToAppendable(source: ByteArray, destination: A, startIndex: Int = 0, endIndex: Int = source.size): A

Encodes bytes from the specified source array or its subrange and appends resulting symbols to the destination appendable. Returns the destination appendable.

Since Kotlin 1.8
Link copied to clipboard
fun encodeToByteArray(source: ByteArray, startIndex: Int = 0, endIndex: Int = source.size): ByteArray

Encodes bytes from the specified source array or its subrange. Returns a ByteArray containing the resulting symbols.

Since Kotlin 1.8