bluetooth-base/com.splendo.kaluga.bluetooth.serialization/LengthPrefix

LengthPrefix

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class LengthPrefix(val lengthAsShort: Boolean = false, val canOverflow: Boolean = false, val sentinel: Byte = 0xFF.toByte())

Annotation added for serializing using BluetoothFormat

When applied to a String, a StringEncodingSettings.LengthPrefix will be used as the StringEncodingSettings.endMarking. Similar encoding will be used to add a length to a List/Map. Defaults to StringEncodingSettings.LengthPrefix.ByteLength

Properties

val canOverflow: Boolean = false

if true will use StringEncodingSettings.LengthPrefix.WithOverflow

val lengthAsShort: Boolean = false

if true will use StringEncodingSettings.LengthPrefix.ShortLength

val sentinel: Byte

the Byte to use as the sentinel for StringEncodingSettings.LengthPrefix.WithOverflow