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

LengthPrefix

sealed class LengthPrefix : StringEncodingSettings.EndMarking

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

Inheritors

Types

data object ByteLength : StringEncodingSettings.LengthPrefix

A LengthPrefix where the size is always encoded as a single UByte

data object ShortLength : StringEncodingSettings.LengthPrefix

A LengthPrefix where the size is always encoded as an UShort

data class WithOverflow(val sentinel: Byte = 0xFF.toByte()) : StringEncodingSettings.LengthPrefix

A LengthPrefix where the size is encoded as an UByte if it fits, or using a sentinel prefix followed by a UShort length

Functions

copyEncodedSizeInto

abstract fun copyEncodedSizeInto(array: ByteArray, size: UInt, order: ByteOrder, offset: Int): ByteArray

Encodes the length of the String as a prefix and copies it into a ByteArray at a given offset.

fun encodeSize(size: UInt, order: ByteOrder): ByteArray

Encodes the length of the String as a prefix.

expectedByteSize

abstract fun expectedByteSize(size: UInt): Int

The expected number of Bytes required to encode the length of the String.