owl-structural-model 2.0.1

Typed OWL 2 structural values for Rust
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

//! Structural key properties, independent of RDF list representation.

use iri_rfc3987::Iri;

use crate::{ObjectPropertyExpression, OperandSet, StructuralModelError};

/// The object and data properties identifying instances in one `HasKey` axiom.
///
/// Either list can be empty; together they must contain at least one property.
/// Object and data properties remain separate even if their IRIs coincide.
#[derive(Debug, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
#[serde(deny_unknown_fields)]
#[serde(try_from = "KeyPropertiesInput")]
pub struct KeyProperties {
    // bounded: object properties in one caller-owned structural key axiom.
    object_properties: OperandSet<ObjectPropertyExpression>,
    // bounded: data properties in one caller-owned structural key axiom.
    data_properties: OperandSet<Iri<String>>,
}

impl KeyProperties {
    /// Create key properties while preserving the two property categories.
    ///
    /// # Errors
    ///
    /// Returns [`StructuralModelError::InvalidFormat`] when both lists are empty.
    pub fn try_new(
        object_properties: Vec<ObjectPropertyExpression>,
        data_properties: Vec<Iri<String>>,
    ) -> Result<Self, StructuralModelError> {
        if object_properties.is_empty() && data_properties.is_empty() {
            return Err(StructuralModelError::InvalidFormat {
                kind: "key properties",
                value: "0".to_owned(),
                message: "requires at least one key property",
            });
        }
        Ok(Self {
            object_properties: OperandSet::new(object_properties),
            data_properties: OperandSet::new(data_properties),
        })
    }

    /// Return the object property expressions.
    #[must_use]
    pub fn object_properties(&self) -> &[ObjectPropertyExpression] {
        self.object_properties.as_slice()
    }

    /// Return the named data properties.
    #[must_use]
    pub fn data_properties(&self) -> &[Iri<String>] {
        self.data_properties.as_slice()
    }
}

#[derive(serde::Deserialize)]
#[serde(deny_unknown_fields)]
struct KeyPropertiesInput {
    // bounded: object properties of one deserialized structural key axiom.
    object_properties: Vec<ObjectPropertyExpression>,
    // bounded: data properties of one deserialized structural key axiom.
    data_properties: Vec<Iri<String>>,
}

impl TryFrom<KeyPropertiesInput> for KeyProperties {
    type Error = StructuralModelError;

    fn try_from(input: KeyPropertiesInput) -> Result<Self, Self::Error> {
        Self::try_new(input.object_properties, input.data_properties)
    }
}