kotlin-stdlib/kotlin.io.encoding

Package-level declarations

API for encoding and decoding data using various encoding schemes, such as Base64.

Types

open class Base64

Provides Base64 encoding and decoding functionality. Base64 encoding, as defined by the RFC 4648 and a few other RFCs, transforms arbitrary binary data into a sequence of printable characters.

Since Kotlin 2.2

ExperimentalEncodingApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalEncodingApi

This annotation marks the experimental API for encoding and decoding between binary data and printable ASCII character sequences.

Since Kotlin 1.8

Functions

decodingWith

@ExperimentalEncodingApi

fun InputStream.decodingWith(base64: Base64): InputStream

Returns an input stream that decodes symbols from this input stream using the specified base64 encoding. Please refer to Base64 documentation for more details on the encoding itself.

Since Kotlin 1.8

encodingWith

@ExperimentalEncodingApi

fun OutputStream.encodingWith(base64: Base64): OutputStream

Returns an output stream that encodes bytes using the specified base64 encoding and writes the result to this output stream. Please refer to Base64 documentation for more details on the encoding itself.

Since Kotlin 1.8

Thanks for your feedback!

Was this page helpful?