Skip to main content

shacl_structural_model/
lib.rs

1#![doc = include_str!("../README.md")]
2#![forbid(unsafe_code)]
3
4//! Typed structural values for SHACL shapes without an RDF-store dependency.
5
6mod component;
7mod custom_component;
8mod error;
9mod expression;
10mod function;
11pub mod inference;
12mod language_tag;
13mod local_name;
14mod node_kind;
15mod node_shape;
16mod parameter;
17mod path;
18mod property_shape;
19mod rule;
20mod severity;
21mod sparql;
22mod target;
23pub mod vocabulary;
24
25pub use component::Component;
26pub use custom_component::{CustomConstraint, CustomConstraintComponent};
27pub use error::{LexicalRole, StructuralModelError};
28pub use expression::{ExpressionConstraint, ExpressionKind, NodeExpression};
29pub use function::ShaclFunction;
30pub use language_tag::LanguageTag;
31pub use local_name::local_name;
32pub use node_kind::NodeKind;
33pub use node_shape::NodeShape;
34pub use parameter::{Parameter, ParameterValues};
35pub use path::ShaclPath;
36pub use property_shape::PropertyShape;
37pub use rdf_structural_model::Term as DefaultTerm;
38pub use rule::{RuleKind, ShaclRule, TripleRule};
39pub use severity::Severity;
40pub use sparql::{
41    PrefixDeclaration, PrefixDeclarations, ResultAnnotation, SparqlConstraint, SparqlQuery,
42    SparqlSelectOrAsk, SparqlValidator,
43};
44pub use target::{CustomTarget, SparqlTarget, SparqlTargetType, Target};
45
46#[cfg(test)]
47mod tests {
48    use super::*;
49
50    #[test]
51    fn default_term_component_is_available() {
52        let component: Component = Component::HasValue(DefaultTerm::literal(
53            rdf_structural_model::Literal::string("value"),
54        ));
55        assert_eq!(component.kind_name(), "hasValue");
56    }
57
58    #[test]
59    fn caller_value_type_can_be_used() {
60        let component: Component<String> = Component::HasValue("value".to_owned());
61        assert_eq!(component.kind_name(), "hasValue");
62    }
63
64    /// ```
65    /// use shacl_structural_model::{Component, DefaultTerm, NodeShape, ShaclPath, Target};
66    ///
67    /// let person = "https://example.org/Person".parse().expect("valid IRI");
68    /// let shape = NodeShape::<DefaultTerm>::new(
69    ///     DefaultTerm::iri("https://example.org/PersonShape".parse().expect("valid IRI")),
70    /// )
71    /// .with_target(Target::Class(person.clone()))
72    /// .with_component(Component::Class(person));
73    ///
74    /// assert_eq!(shape.components[0].kind_name(), "class");
75    /// assert_eq!(ShaclPath::Predicate("https://example.org/name".parse().unwrap()).to_string(), "name");
76    /// ```
77    #[test]
78    fn doctest_anchor() {}
79}