cdx-core 0.7.1

Core library for reading, writing, and validating Codex Document Format (.cdx) files
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

//! # cdx-core
//!
//! Core library for reading, writing, and validating Codex Document Format (`.cdx`) files.
//!
//! ## Overview
//!
//! Codex is an open document format designed for semantic content, verifiable integrity,
//! and machine readability. This library provides the foundational capabilities for working
//! with Codex documents in Rust.
//!
//! ## Quick Start
//!
//! ```rust,ignore
//! use cdx_core::{Document, DocumentState};
//!
//! // Open an existing document
//! let doc = Document::open("example.cdx")?;
//! println!("State: {:?}", doc.state());
//!
//! // Verify document integrity
//! doc.verify()?;
//! ```
//!
//! ## Features
//!
//! - `zstd` (default): Zstandard compression support
//! - `wasm`: WASM compilation support

#![cfg_attr(docsrs, feature(doc_cfg))]
#![deny(missing_docs)]
#![deny(unsafe_code)]
#![warn(clippy::all)]
#![warn(clippy::pedantic)]
#![allow(clippy::module_name_repetitions)]

pub mod anchor;
pub mod archive;
pub mod asset;
pub mod content;
mod document;
mod error;
pub mod extensions;
mod hash;
mod manifest;
pub mod metadata;
pub mod presentation;
pub mod provenance;
#[cfg(feature = "signatures")]
#[cfg_attr(docsrs, doc(cfg(feature = "signatures")))]
pub mod security;
mod state;
pub mod validation;

pub use document::{Document, DocumentBuilder, ExtensionValidationReport, VerificationReport};
pub use error::{Error, Result};
pub use hash::{DocumentId, HashAlgorithm, Hasher};
pub use manifest::{
    AssetManifest, ContentRef, Extension, FileRef, Lineage, Manifest, Metadata, PresentationRef,
    SecurityRef,
};
pub use state::DocumentState;

/// Codex specification version implemented by this library.
pub const SPEC_VERSION: &str = "0.1";

/// Default file extension for Codex documents.
pub const FILE_EXTENSION: &str = "cdx";

/// MIME type for Codex documents (JSON format).
pub const MIME_TYPE: &str = "application/vnd.codex+json";

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

    #[test]
    fn test_constants() {
        assert_eq!(SPEC_VERSION, "0.1");
        assert_eq!(FILE_EXTENSION, "cdx");
        assert_eq!(MIME_TYPE, "application/vnd.codex+json");
    }
}