sdc4-validator 0.1.0

High-performance XML Schema validator with Semantic Data Charter (SDC4) support
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! # sdc4-validator
//!
//! A high-performance XML Schema validator with Semantic Data Charter (SDC4) support.
//!
//! ## Overview
//!
//! `sdc4-validator` provides fast and memory-efficient validation of XML documents
//! against XML Schema definitions with specialized support for healthcare data quality
//! management through the Semantic Data Charter specification.
//!
//! Unlike traditional validators that reject invalid data, `sdc4-validator` implements
//! a "quarantine-and-tag" pattern that preserves problematic data while injecting
//! ISO 21090-based `ExceptionalValue` elements.
//!
//! ## Quick Start (Coming in v4.0.0)
//!
//! ```text
//! use sdc4_validator::{Validator, ValidationOptions};
//!
//! fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     // Create validator with schema
//!     let validator = Validator::from_file("schema.xsd")?;
//!
//!     // Validate XML document
//!     let xml = std::fs::read_to_string("data.xml")?;
//!     let result = validator.validate(&xml)?;
//!
//!     if result.is_valid() {
//!         println!("Document is valid!");
//!     } else {
//!         println!("Validation errors: {:?}", result.errors());
//!     }
//!     Ok(())
//! }
//! ```
//!
//! ## Features
//!
//! - **High Performance**: Native Rust implementation for optimal speed
//! - **SDC4 Compliance**: Full support for Semantic Data Charter 4.x specification
//! - **ExceptionalValue Support**: Automatic injection of ISO 21090-based exceptional values
//! - **Recovery Mode**: Tag and preserve invalid data rather than rejecting it
//!
//! ## Status
//!
//! **PLACEHOLDER RELEASE - NOT FUNCTIONAL**
//!
//! This is a v0.1.0 placeholder to reserve the package name on crates.io.
//! The full implementation is scheduled for Q2 2026 and will be released as v4.0.0.
//!
//! For production use today, please see:
//! - [sdcvalidator (Python)](https://github.com/SemanticDataCharter/sdcvalidator) - Reference implementation
//! - [@semanticdatacharter/validator](https://www.npmjs.com/package/@semanticdatacharter/validator) - JavaScript/TypeScript
//!
//! This library is currently in the planning phase with implementation scheduled for Q2 2026.

#![warn(missing_docs)]
#![warn(clippy::all)]

// Module declarations (to be implemented)
// pub mod parser;
// pub mod schema;
// pub mod recovery;
// pub mod errors;
// pub mod api;

// Re-exports for convenience (to be implemented)
// pub use api::{Validator, ValidationOptions, ValidationResult};
// pub use errors::{Error, Result};
// pub use recovery::{RecoveryOptions, ExceptionalValueType};

// Placeholder for initial development

/// Returns information about this placeholder release.
///
/// # Placeholder Release
///
/// This is v0.1.0 placeholder to reserve the `sdc4-validator` name on crates.io.
/// The functional implementation will be released as v4.0.0 in Q2 2026.
///
/// # Example
///
/// ```
/// use sdc4_validator::placeholder_info;
///
/// let info = placeholder_info();
/// println!("{}", info);
/// ```
pub fn placeholder_info() -> &'static str {
    "sdc4-validator v0.1.0 - Placeholder release (Implementation planned Q2 2026)"
}

#[deprecated(
    since = "0.1.0",
    note = "This is a placeholder release. Functional API will be available in v4.0.0 (Q2 2026)"
)]
/// Placeholder function - do not use.
pub fn placeholder() {
    println!("sdc4-validator - Planning phase (Q2 2026)");
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_placeholder() {
        placeholder();
    }
}