oscal 0.1.1

Serde types for the OSCAL (Open Security Controls Assessment Language) data models. Generated from the official NIST Metaschema, covering all seven OSCAL document types. Ships embedded community catalogs for AI governance and security frameworks.
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
111
112
113
114
115
116
117
118
119
120
121

//! Strong primitive types for OSCAL's rich-text and URI data types.
//!
//! These wrap `String` but carry semantic meaning in the type system and ensure
//! correct serde round-trips. Downstream code should prefer these over bare
//! `String` for any OSCAL field typed `markup-line`, `markup-multiline`, or
//! `uri-reference`.

use serde::{Deserialize, Serialize};
use std::fmt;

/// Inline rich text with emphasis, links, code spans, and similar inline formatting.
///
/// Maps to the OSCAL Metaschema `markup-line` data type. The inner string may
/// contain Markdown or a limited HTML subset depending on the serialization
/// format; this crate stores it verbatim without parsing.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize, Default)]
#[serde(transparent)]
pub struct MarkupLine(pub String);

/// Block-level rich text: paragraphs, headings, lists, tables, and inline markup.
///
/// Maps to the OSCAL Metaschema `markup-multiline` data type.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize, Default)]
#[serde(transparent)]
pub struct MarkupMultiline(pub String);

/// A URI reference that may be relative, absolute, or a bare fragment (`#uuid`).
///
/// Maps to the OSCAL Metaschema `uri-reference` data type. Unlike `url::Url`,
/// this type accepts relative URIs such as `#uuid-back-matter-ref` which appear
/// extensively in OSCAL back-matter cross-references.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize, Default)]
#[serde(transparent)]
pub struct UriReference(pub String);

// ── MarkupLine conversions ────────────────────────────────────────────────────

impl From<&str> for MarkupLine {
    #[inline]
    fn from(s: &str) -> Self {
        Self(s.to_owned())
    }
}

impl From<String> for MarkupLine {
    #[inline]
    fn from(s: String) -> Self {
        Self(s)
    }
}

impl fmt::Display for MarkupLine {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.0.fmt(f)
    }
}

impl AsRef<str> for MarkupLine {
    #[inline]
    fn as_ref(&self) -> &str {
        &self.0
    }
}

// ── MarkupMultiline conversions ───────────────────────────────────────────────

impl From<&str> for MarkupMultiline {
    #[inline]
    fn from(s: &str) -> Self {
        Self(s.to_owned())
    }
}

impl From<String> for MarkupMultiline {
    #[inline]
    fn from(s: String) -> Self {
        Self(s)
    }
}

impl fmt::Display for MarkupMultiline {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.0.fmt(f)
    }
}

impl AsRef<str> for MarkupMultiline {
    #[inline]
    fn as_ref(&self) -> &str {
        &self.0
    }
}

// ── UriReference conversions ──────────────────────────────────────────────────

impl From<&str> for UriReference {
    #[inline]
    fn from(s: &str) -> Self {
        Self(s.to_owned())
    }
}

impl From<String> for UriReference {
    #[inline]
    fn from(s: String) -> Self {
        Self(s)
    }
}

impl fmt::Display for UriReference {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.0.fmt(f)
    }
}

impl AsRef<str> for UriReference {
    #[inline]
    fn as_ref(&self) -> &str {
        &self.0
    }
}