Enum nakadi_types::event_type::CompatibilityMode

pub enum CompatibilityMode {
    Compatible,
    Forward,
    None,
}

Compatibility mode provides a mean for event owners to evolve their schema, given changes respect the semantics defined by this field.

It’s designed to be flexible enough so that producers can evolve their schemas while not inadvertently breaking existent consumers.

Once defined, the compatibility mode is fixed, since otherwise it would break a predefined contract, declared by the producer.

The default is forward.

See also Nakadi Manual

Variants

Compatible

Consumers can reliably parse events produced under different versions. Every event published since the first version is still valid based on the newest schema. When in compatible mode, it’s allowed to add new optional properties and definitions to an existing schema, but no other changes are allowed. Under this mode, the following json-schema attributes are not supported: not, patternProperties, additionalProperties and additionalItems. When validating events, additional properties is false.

Forward

Compatible schema changes are allowed. It’s possible to use the full json schema specification for defining schemas. Consumers of forward compatible event types can safely read events tagged with the latest schema version as long as they follow the robustness principle.

None

Any schema modification is accepted, even if it might break existing producers or consumers. When validating events, no additional properties are accepted unless explicitly stated in the schema.

Trait Implementations

impl Clone for CompatibilityMode

fn clone(&self) -> CompatibilityMode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CompatibilityMode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CompatibilityMode

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CompatibilityMode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<CompatibilityMode> for CompatibilityMode

fn eq(&self, other: &CompatibilityMode) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for CompatibilityMode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Copy for CompatibilityMode

impl Eq for CompatibilityMode

impl StructuralEq for CompatibilityMode

impl StructuralPartialEq for CompatibilityMode