core/elide.core.encoding

Package-level declarations

Cross-platform encoding utilities and API.

Types

DefaultBase64 is now the default implementation.

interface Codec<Raw : EncodedData> : Encoder<Raw> , Decoder<Raw> , CodecIdentifiable

Specifies the expected API interface for an encoding tool, which is capable of encoding data to a given format or expression, as well as decoding from that same format.

CodecIdentifiable

interface CodecIdentifiable

Describes a component of a Codec, or a generic data object that can identify an Encoding. Raw data outputs are also CodecIdentifiable by default.

Decoder

interface Decoder<Raw : EncodedData> : CodecIdentifiable

EncodedData

interface EncodedData

Specifies the interface which encoded data value classes comply with; each encoded data class indicates its encoding, and provides a means for decoding to/from strings.

Encoder

interface Encoder<Raw : EncodedData> : CodecIdentifiable

Encoding

enum Encoding : Enum<Encoding>

Enumerates supported encodings and binds Encoder instances to each.

Hex

typealias Hex = DefaultHex

DefaultHex is now the default implementation.

Functions

toBase64

fun ByteArray.toBase64(): Base64Data

Encode the current ByteArray to a Base64 byte array wrapped using an encoded data record.

fun String.toBase64(): Base64Data

Encode the current String to a Base64 byte array, using the cross-platform DefaultBase64 tools.

toBase64Bytes

fun ByteArray.toBase64Bytes(): ByteArray

Encode the current ByteArray to a Base64 byte array, using the cross-platform DefaultBase64 tools.

fun String.toBase64Bytes(): ByteArray

Encode the current String to a Base64 byte array, using the cross-platform DefaultBase64 tools.

toBase64String

fun ByteArray.toBase64String(): String

Encode the current ByteArray to a Base64 string, using the cross-platform DefaultBase64 tools.

fun String.toBase64String(): String

Encode the current String to a Base64 string, using the cross-platform DefaultBase64 tools.

toHex

fun ByteArray.toHex(): HexData

Encode the current ByteArray to a hex-encoded string, wrapped in a HexData record.

fun String.toHex(): HexData

Encode the current String to a hex-encoded string, wrapped in a HexData record.

toHexBytes

fun ByteArray.toHexBytes(): ByteArray

Encode the current ByteArray to a hex-encoded byte array, using the cross-platform DefaultHex tools.

fun String.toHexBytes(): ByteArray

Encode the current String to a hex-encoded byte array, using the cross-platform DefaultHex tools.

toHexString

fun ByteArray.toHexString(): String

Encode the current ByteArray to a hex-encoded string, using the cross-platform DefaultHex tools.

fun String.toHexString(): String

Encode the current String to a hex-encoded string, using the cross-platform DefaultHex tools.