axioval-ir 0.3.0

Source-neutral semantic IR and validation result contracts for Axioval
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

#![allow(missing_docs)]
use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;

#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct LocalizedText {
    pub default: String,
    #[serde(default)]
    pub translations: BTreeMap<String, String>,
}

impl LocalizedText {
    /// Text with no translations.
    #[must_use]
    pub fn plain(text: impl Into<String>) -> Self {
        Self {
            default: text.into(),
            translations: BTreeMap::new(),
        }
    }
}

/// Package identity and presentation metadata.
///
/// `name` and `description` are localized in the normalized MCS contract.
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct PackageMetadata {
    pub id: String,
    pub name: LocalizedText,
    pub version: String,
    pub description: Option<LocalizedText>,
    pub repository: Option<String>,
    pub license: Option<String>,
    #[serde(default)]
    pub authors: Vec<String>,
}

/// One external-schema name for a canonical concept.
///
/// `type_system` is the release-bound semantic identity the source adapter
/// declares, for example `https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4`.
/// Binding a concept to source data requires an exact match on it.
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ExternalName {
    #[serde(rename = "typeSystem")]
    pub type_system: String,
    pub name: String,
}

/// A bibliographic source a package may cite. Provenance only: it never changes
/// selection, evidence, or outcomes.
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct Source {
    pub id: String,
    pub kind: String,
    pub designation: String,
    pub title: LocalizedText,
    pub publisher: Option<String>,
    pub edition: Option<String>,
    pub publication_date: Option<String>,
    pub url: Option<String>,
}

/// One pinpoint within a cited source.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Locator {
    pub kind: String,
    pub value: String,
}

/// A reference to one package source.
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct Citation {
    pub id: String,
    pub source_id: String,
    #[serde(default)]
    pub locators: Vec<Locator>,
    pub note: Option<LocalizedText>,
}