panproto-check 0.68.0

Breaking change detection for panproto
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

//! # panproto-check
//!
//! Breaking change detection for panproto.
//!
//! This crate analyzes schema migrations and lens definitions to
//! determine whether a proposed change is backward-compatible,
//! producing detailed diagnostics when breaking changes are found.
//!
//! The pipeline is:
//! 1. [`diff()`] two schemas to produce a [`SchemaDiff`].
//! 2. [`classify()`] the diff against a [`Protocol`](panproto_schema::Protocol) to get a [`CompatReport`].
//! 3. Render via [`report_text`] (human-readable) or [`report_json`] (machine-readable).

// Allow concrete HashMap in public API per ENGINEERING.md.
#![allow(clippy::implicit_hasher)]

pub mod classify;
pub mod diff;
pub mod error;
pub mod report;
pub mod scope;

pub use classify::{
    BreakingChange, Classification, CompatReport, NonBreakingChange, classify,
    classify_with_schemas,
};
pub use diff::{ConstraintChange, ConstraintDiff, KindChange, SchemaDiff, apply_renames, diff};
pub use error::CheckError;
pub use report::{report_json, report_text};
pub use scope::{
    ElementStatus, NamedElement, ScopeChange, ScopeChangeKind, ScopeReport, report_by_scope,
    report_scope_json, report_scope_text,
};