shacl-structural-model 4.0.2

Typed SHACL structural values for Rust
Documentation
//! SHACL Advanced Features rule declarations.

use crate::{NodeExpression, SparqlQuery};

/// A SHACL-AF rule with its identity, execution metadata, and declared bodies.
#[derive(Debug, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ShaclRule<Value = crate::DefaultTerm> {
    /// The rule's IRI or blank node.
    pub id: Value,
    /// The original numeric `sh:order` literal.
    pub order: Option<Value>,
    /// Whether the rule is deactivated.
    pub deactivated: bool,
    /// IRI or blank-node references to `sh:condition` shapes.
    pub conditions: Vec<Value>,
    /// Supported rule bodies. A resource may declare multiple rule types.
    pub kinds: Vec<RuleKind<Value>>,
}

impl<Value> ShaclRule<Value> {
    /// Create an active rule with one body and no order or conditions.
    #[must_use]
    pub fn new(id: Value, kind: RuleKind<Value>) -> Self {
        Self {
            id,
            order: None,
            deactivated: false,
            conditions: Vec::new(),
            kinds: vec![kind],
        }
    }
}

/// A declarative rule body; no query or node expression is executed here.
#[derive(Debug, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
#[serde(deny_unknown_fields)]
pub enum RuleKind<Value = crate::DefaultTerm> {
    /// A `sh:SPARQLRule` with its CONSTRUCT query declaration.
    Sparql(SparqlQuery<Value>),
    /// A `sh:TripleRule` with three node expressions.
    Triple(Box<TripleRule<Value>>),
}

/// The three expressions of a `sh:TripleRule`.
#[derive(Debug, Clone, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
#[serde(deny_unknown_fields)]
pub struct TripleRule<Value = crate::DefaultTerm> {
    /// The `sh:subject` expression.
    pub subject: NodeExpression<Value>,
    /// The `sh:predicate` expression.
    pub predicate: NodeExpression<Value>,
    /// The `sh:object` expression.
    pub object: NodeExpression<Value>,
}