core/io.matthewnelson.encoding.core

Package-level declarations

Types

Decoder

sealed class Decoder<C : EncoderDecoder.Config>(val config: C)

Decode things.

Encoder

sealed class Encoder<C : EncoderDecoder.Config>(config: C) : Decoder<C>

Encode things.

EncoderDecoder

abstract class EncoderDecoder<C : EncoderDecoder.Config>(config: C) : Encoder<C>

Base abstraction which exposes Encoder and Decoder (sealed classes) such that inheriting classes must implement both.

EncodingException

open class EncodingException : RuntimeException

The EncodingException class is a generic encoding exception class that provide type safety for all the encoding related exception classes that extend from it.

EncodingSizeException

open class EncodingSizeException : EncodingException

This exception is thrown to indicate that an EncoderDecoder.Config pre-calculation step for an operation failed.

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

Denotes an api as experimental, such that it may change inadvertently without notice.

MalformedEncodingException

open class MalformedEncodingException : EncodingException

This exception is thrown to indicate an encoding/decoding operation failed due to malformed input, such as an invalid character or byte sequence.

Functions

use

inline fun <C : EncoderDecoder.Config, T : EncoderDecoder.Feed<C>?, V> T.use(block: (T) -> V): V

Executes the given block function and then closes the Feed by either: