Struct SchemaComparisonSettings 

pub struct SchemaComparisonSettings { /* private fields */ }

Implementations

impl SchemaComparisonSettings

pub const fn require_equality() -> SchemaComparisonSettings

A set of defaults intended to enforce effective equality of the schemas, but with clear error messages if they diverge

pub const fn allow_extension() -> SchemaComparisonSettings

A set of defaults intended to capture a pretty tight definition of structural extension.

This captures that:

• Payloads which are valid/decodable against the old schema are valid against the new schema
• Programmatic SBOR JSON is unchanged (that is, type/field/variant names are also unchanged)

Notably:

• Type roots can be added in the compared schema, but we check that the type roots provided completely cover both schemas
• Types must be structurally identical on their intersection, except new enum variants can be added
• Type metadata (e.g. names) must be identical on their intersection
• Type validation must be equal or strictly weaker in the new schema

pub fn with_completeness( self, builder: impl FnOnce(SchemaComparisonCompletenessSettings) -> SchemaComparisonCompletenessSettings, ) -> SchemaComparisonSettings

pub const fn set_completeness( self, settings: SchemaComparisonCompletenessSettings, ) -> SchemaComparisonSettings

pub fn with_structure( self, builder: impl FnOnce(SchemaComparisonStructureSettings) -> SchemaComparisonStructureSettings, ) -> SchemaComparisonSettings

pub const fn set_structure( self, settings: SchemaComparisonStructureSettings, ) -> SchemaComparisonSettings

pub fn with_metadata( self, builder: impl FnOnce(SchemaComparisonMetadataSettings) -> SchemaComparisonMetadataSettings, ) -> SchemaComparisonSettings

pub const fn set_metadata( self, settings: SchemaComparisonMetadataSettings, ) -> SchemaComparisonSettings

pub const fn allow_all_name_changes(self) -> SchemaComparisonSettings

An easy method for a common setting change

pub fn with_validation( self, builder: impl FnOnce(SchemaComparisonValidationSettings) -> SchemaComparisonValidationSettings, ) -> SchemaComparisonSettings

pub const fn set_validation( self, settings: SchemaComparisonValidationSettings, ) -> SchemaComparisonSettings

Trait Implementations

impl Clone for SchemaComparisonSettings

fn clone(&self) -> SchemaComparisonSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaComparisonSettings

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

Formats the value using the given formatter.

impl PartialEq for SchemaComparisonSettings

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SchemaComparisonSettings

impl Eq for SchemaComparisonSettings

impl StructuralPartialEq for SchemaComparisonSettings