Enum ChangeKind

Source

pub enum ChangeKind {
Show 28 variants    TypeAdd {
        added: JsonSchemaType,
    },
    TypeRemove {
        removed: JsonSchemaType,
    },
    ConstAdd {
        added: Value,
    },
    ConstRemove {
        removed: Value,
    },
    PropertyAdd {
        lhs_additional_properties: bool,
        added: String,
    },
    PropertyRemove {
        lhs_additional_properties: bool,
        removed: String,
    },
    RangeAdd {
        added: Range,
    },
    RangeRemove {
        removed: Range,
    },
    RangeChange {
        old_value: Range,
        new_value: Range,
    },
    TupleToArray {
        old_length: usize,
    },
    ArrayToTuple {
        new_length: usize,
    },
    TupleChange {
        new_length: usize,
    },
    RequiredRemove {
        property: String,
    },
    RequiredAdd {
        property: String,
    },
    FormatAdd {
        added: String,
    },
    FormatRemove {
        removed: String,
    },
    FormatChange {
        old_format: String,
        new_format: String,
    },
    EnumAdd {
        added: Value,
        lhs_has_no_enum: bool,
    },
    EnumRemove {
        removed: Value,
        rhs_has_no_enum: bool,
    },
    PatternAdd {
        added: String,
    },
    PatternRemove {
        removed: String,
    },
    PatternChange {
        old_pattern: String,
        new_pattern: String,
    },
    MinLengthAdd {
        added: u32,
    },
    MinLengthRemove {
        removed: u32,
    },
    MinLengthChange {
        old_value: u32,
        new_value: u32,
    },
    MaxLengthAdd {
        added: u32,
    },
    MaxLengthRemove {
        removed: u32,
    },
    MaxLengthChange {
        old_value: u32,
        new_value: u32,
    },
}

Expand description

The kind of change + data relevant to the change.

Variants§

§

TypeAdd

A type has been added and is now additionally allowed.

Fields

§added: JsonSchemaType

The type in question.

§

TypeRemove

A type has been removed and is no longer allowed.

Fields

§removed: JsonSchemaType

The type in question.

§

ConstAdd

A const value has been added as an allowed value.

Fields

§added: Value

The value of the added const.

§

ConstRemove

A const has been removed as an allowed value.

Fields

§removed: Value

The value of the removed const.

§

PropertyAdd

A property has been added and (depending on additionalProperties) is now additionally allowed.

Fields

§lhs_additional_properties: bool

The value of additionalProperties within the current JSON object.

§added: String

The name of the added property.

§

PropertyRemove

A property has been removed and (depending on additionalProperties) might now no longer be allowed.

Fields

§lhs_additional_properties: bool

The value of additionalProperties within the current JSON object.

§removed: String

The name of the added property.

§

RangeAdd

A minimum/maximum constraint has been added.

Fields

§added: Range

The value of the added constraint.

§

RangeRemove

A minimum/maximum constraint has been removed.

Fields

§removed: Range

The value of the removed constraint.

§

RangeChange

A minimum/maximum constraint has been updated.

Fields

§old_value: Range

The old constraint value.

§new_value: Range

The new constraint value.

§

TupleToArray

An array-type item has been changed from tuple validation to array validation.

See https://json-schema.org/understanding-json-schema/reference/array.html

Changes will still be emitted for inner items.

Fields

§old_length: usize

The length of the (old) tuple

§

ArrayToTuple

An array-type item has been changed from array validation to tuple validation.

See https://json-schema.org/understanding-json-schema/reference/array.html

Changes will still be emitted for inner items.

Fields

§new_length: usize

The length of the (new) tuple

§

TupleChange

An array-type item with tuple validation has changed its length (“items” array got longer or shorter.

See https://json-schema.org/understanding-json-schema/reference/array.html

Changes will still be emitted for inner items.

Fields

§new_length: usize

The new length of the tuple

§

RequiredRemove

A previously required property has been removed

Fields

§property: String

The property that is no longer required

§

RequiredAdd

A previously optional property has been made required

Fields

§property: String

The property that is now required

§

FormatAdd

A format constraint has been added.

Fields

§added: String

The format that was added.

§

FormatRemove

A format constraint has been removed.

Fields

§removed: String

The format that was removed.

§

FormatChange

A format constraint has been changed.

Fields

§old_format: String

The old format value.

§new_format: String

The new format value.

§

EnumAdd

An enum value has been added to the allowed values.

Fields

§added: Value

The value that was added to the enum.

§lhs_has_no_enum: bool

Whether the enum constraint was added (lhs had no enum). If true, this is breaking as it adds a new constraint.

§

EnumRemove

An enum value has been removed from the allowed values.

Fields

§removed: Value

The value that was removed from the enum.

§rhs_has_no_enum: bool

Whether the entire enum constraint was removed (rhs has no enum). If true, this is non-breaking as it relaxes the constraint.

§

PatternAdd

A pattern constraint has been added.

Fields

§added: String

The pattern that was added.

§

PatternRemove

A pattern constraint has been removed.

Fields

§removed: String

The pattern that was removed.

§

PatternChange

A pattern constraint has been changed.

Fields

§old_pattern: String

The old pattern value.

§new_pattern: String

The new pattern value.

§

MinLengthAdd

A minLength constraint has been added.

Fields

§added: u32

The minLength value that was added.

§

MinLengthRemove

A minLength constraint has been removed.

Fields

§removed: u32

The minLength value that was removed.

§

MinLengthChange

A minLength constraint has been changed.

Fields

§old_value: u32

The old minLength value.

§new_value: u32

The new minLength value.

§

MaxLengthAdd

A maxLength constraint has been added.

Fields

§added: u32

The maxLength value that was added.

§

MaxLengthRemove

A maxLength constraint has been removed.

Fields

§removed: u32

The maxLength value that was removed.

§

MaxLengthChange

A maxLength constraint has been changed.

Fields

§old_value: u32

The old maxLength value.

§new_value: u32

The new maxLength value.

Implementations§

Source §

impl ChangeKind

Source

pub fn is_breaking(&self) -> bool

Whether the change is breaking.

What is considered breaking is WIP. Changes are intentionally exposed as-is in public API so that the user can develop their own logic as to what they consider breaking.

Currently the rule of thumb is, a change is breaking if it would cause messages that used to validate fine under RHS to no longer validate under LHS.