aas 0.4.0

Data type bindings for the Asset Administration Shell Specs
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

use serde::{Deserialize, Serialize};
use strum::{Display, EnumString};
#[cfg(feature = "openapi")]
use utoipa::ToSchema;

pub type KeyReference = String;

/// Specifies the reference context for this key in the Asset Administration Shell (AAS) metamodel.
///
/// When the key type is `Key::GlobalReference`, it targets an external resource identified by a
/// globally unique identifier,
/// such as an IRI, IRDI, or URI, typically pointing to referable entities like
/// ConceptDescriptions outside the current AAS context.
/// This facilitates interoperability by enabling unambiguous referencing across distributed systems.
///
/// For `Key::FragmentReference`, the key identifies a fragment or local anchor within its parent element,
/// scoped by the reference chain defined by preceding keys. This allows fine-grained references to subcomponents,
/// such as elements within documents or data blobs.
///
/// Other key types identify specific model elements (like Submodel, SubmodelElement, or Asset)
/// within the same or another AAS,
/// explicitly naming the referenced element to enable precise navigation within the AAS environment.
#[derive(EnumString, Display, Clone, PartialEq, Debug, Deserialize, Serialize)]
#[serde(tag = "type", content = "value")]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
pub enum Key {
    AnnotatedRelationshipElement(KeyReference),
    AssetAdministrationShell(KeyReference),
    BasicEventElement(KeyReference),
    Blob(KeyReference),
    Capability(KeyReference),
    ConceptDescription(KeyReference),
    DataElement(KeyReference),
    Entity(KeyReference),
    EventElement(KeyReference),
    File(KeyReference),
    FragmentReference(KeyReference),
    GlobalReference(KeyReference),
    Identifiable(KeyReference),
    MultiLanguageProperty(KeyReference),
    Operation(KeyReference),
    Property(KeyReference),
    Range(KeyReference),
    Referable(KeyReference),
    ReferenceElement(KeyReference),
    RelationshipElement(KeyReference),
    Submodel(KeyReference),
    SubmodelElement(KeyReference),
    SubmodelElementCollection(KeyReference),
    SubmodelElementList(KeyReference),
}

pub mod xml {
    #[cfg(test)]
    mod tests {}
}

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

    #[test]
    fn serialize() {
        let json = r#"
        {
          "type": "Submodel",
          "value": "https://example.com/idta/Submodel/Test"
        }
        "#;

        let expected = Key::Submodel("https://example.com/idta/Submodel/Test".to_string());

        let actual: Key = serde_json::from_str(json).expect("Not serializing");

        assert_eq!(actual, expected);
    }
}