serialkompat-core/com.chrisjenx.serialkompat.core/CompatibilityDirection

CompatibilityDirection

enum CompatibilityDirection : Enum<CompatibilityDirection>

Direction(s) of compatibility a check enforces.

Uses Confluent Schema Registry's vocabulary. Maps onto kotlinx-serialization's reader/writer asymmetry: the decoder is the reader, the encoder is the writer.

Entries

BACKWARD

New code must be able to read data written by old code.

FORWARD

Old code must be able to read data written by new code.

FULL

Both BACKWARD and FORWARD.

Properties

checksBackward

val checksBackward: Boolean

Whether this direction requires backward-compatibility checks.

checksForward

val checksForward: Boolean

Whether this direction requires forward-compatibility checks.

entries

val entries: EnumEntries<CompatibilityDirection>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): CompatibilityDirection

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<CompatibilityDirection>

Returns an array containing the constants of this enum type, in the order they're declared.