base/com.splendo.kaluga.base.bytes/StringEncodingSettings

StringEncodingSettings

data class StringEncodingSettings(val endMarking: StringEncodingSettings.EndMarking = LengthPrefix.ByteLength, val encoding: Encoding = Encoding.UTF_8)

Settings to determine how a String should be encoded into a ByteArray.

Constructors

constructor(endMarking: StringEncodingSettings.EndMarking = LengthPrefix.ByteLength, encoding: Encoding = Encoding.UTF_8)

Types

EndMarking

sealed class EndMarking

Method used for marking the end of a String when encoding it to a ByteArray

FixedLength

data class FixedLength(val length: Int) : StringEncodingSettings.EndMarking

An EndMarking where the String is always encoded as a fixed length length. If the string is longer, its final characters will be dropped. If it is smaller, it will be padded with null characters.

LengthPrefix

sealed class LengthPrefix : StringEncodingSettings.EndMarking

An EndMarking where the length of the String is encoded as a prefix.

NoMarking

data object NoMarking : StringEncodingSettings.EndMarking

No EndMarking will be used, the entire array should be decoded

NullTerminated

data object NullTerminated : StringEncodingSettings.EndMarking

An EndMarking where the end is marked by a final empty character \u0000. If the string contains this character encoding will fail.

Properties

encoding

val encoding: Encoding

The Encoding to use for encoding the string.

endMarking

val endMarking: StringEncodingSettings.EndMarking

The EndMarking to use for encoding when the string ends.