dtcs 0.3.0

Reference implementation of the Data Transformation Contract Standard (DTCS)
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

//! Compatibility and evolution report types.

use serde::{Deserialize, Serialize};

use crate::diagnostics::Diagnostic;

use super::types::{AspectResult, ChangeCategory, CompatibilityLevel};

/// Result of compatibility analysis (SPEC Chapter 11).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CompatibilityReport {
    /// Overall compatibility classification.
    pub level: CompatibilityLevel,
    /// Per-aspect summaries.
    pub aspects: Vec<AspectResult>,
    /// Diagnostics including violations and notes.
    pub diagnostics: Vec<Diagnostic>,
}

impl CompatibilityReport {
    /// Returns `true` when the pair is not incompatible.
    #[must_use]
    pub fn is_compatible(&self) -> bool {
        !matches!(self.level, CompatibilityLevel::Incompatible)
    }
}

/// A categorized contract change detected during evolution analysis.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ContractChange {
    /// Change category (SPEC Chapter 12 §6).
    pub category: ChangeCategory,
    /// Human-readable description.
    pub message: String,
    /// Affected object reference.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub object_ref: Option<String>,
}

/// Result of evolution analysis (SPEC Chapter 12).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EvolutionReport {
    /// Older revision contract id.
    pub source_id: String,
    /// Newer revision contract id.
    pub target_id: String,
    /// Whether both revisions share the same logical identity.
    pub same_identity: bool,
    /// Underlying compatibility level.
    pub compatibility: CompatibilityLevel,
    /// Detected changes by category.
    pub changes: Vec<ContractChange>,
    /// Informative migration guidance (SPEC Chapter 12 §9).
    pub migration_hints: Vec<String>,
    /// Diagnostics.
    pub diagnostics: Vec<Diagnostic>,
}