shacl-structural-model
Typed structural values for SHACL shapes in Rust.
shacl-structural-model represents SHACL shapes, property paths, targets,
constraint components, severities, RDF messages, SPARQL declarations, and
SHACL Advanced Features functions, expressions and rules. It is intended for parsers,
editors, validators, serializers, and storage adapters that need typed shape
values without taking a dependency on an RDF graph implementation.
The default value type is [rdf_structural_model::Term]. The structural types are also
generic over the value type, so an application can use its own RDF term model
without copying or converting RDF-valued fields. Shape IDs and references
retain blank nodes; target nodes can also be literals. Messages keep language
tags and datatypes. Numeric ordering literals retain their lexical precision.
This crate models structural values only. It does not parse RDF, read or write files, access a graph store, execute validation, run SPARQL, or collect an entire shapes graph. Callers should stream shapes from their input and retain only the structural values needed by their operation.
W3C specifications
The stable baseline is the SHACL Recommendation.
SPARQL and AF declarations follow that recommendation and
SHACL Advanced Features.
Representing these declarations does not establish validator conformance or
pySHACL compatibility. The Component::SingleLine(bool) declaration follows
SHACL 1.2 Core, Working Draft 14 October 2026, section 7.4.4.
It preserves both true and explicit false through nested JSON and binary
serialization. The draft marks this constraint at risk; this crate represents
the declaration without executing it. SHACL-JS and complete SHACL 1.2 draft
coverage remain outside the implemented scope.
The same draft's list constraint declarations (section 7.5)
are represented by MemberShape(Value), MinListLength(Count),
MaxListLength(Count) and UniqueMembers(bool). Member-shape references retain
caller-owned RDF identity; length bounds retain exact RDF values or independent
compiled counts without a machine-integer limit. Explicit UniqueMembers(false)
relaxes uniqueness while still requiring a valid SHACL list in the draft.
Consumers own integer validation, list traversal, member validation, equality
and report construction. These declarations do not traverse or collect lists.
Example
use Iri;
use ;
use ;
let person: = "https://example.org/Person".parse.expect;
let name: = "https://example.org/name".parse.expect;
let name_shape = new
.with_component;
let person_shape = new
.with_target
.with_property_shape;
assert_eq!;
assert_eq!;
Value types
RDF-valued fields default to rdf_structural_model::Term. Applications can instead use
oxrdf::Term, references to their existing terms, or opaque term handles.
Construction has no Clone, Debug, or Serde bounds; those traits are required
only when calling the corresponding operations. IRIs in IRI-only roles, such
as predicates and datatypes, default to iri_rfc3987::Iri<String>. The independent
Named parameter accepts a caller-owned named-node type when programmatic RDF
terms preserve relative or otherwise non-RFC lexical values. This does not
relax the default IRI parser or accept arbitrary RDF values in named roles.
use Component;
let constraint: = Pattern ;
assert_eq!;
Count and length parameters preserve the caller's RDF value type, including
signed and arbitrary-size integers. Component<Value, Count>,
NodeShape<Value, Count>, PropertyShape<Value, Count>, and parameterized
declarations also accept a separate compiled count type; Count defaults to
Value. The model does not parse lexical forms, impose a u64 limit, or read
literal payloads. Order values stay as RDF terms, independently of Count.
Regex flag parameters likewise retain Value by default. The independent
third generic Flags is available on components, shapes, parameters, custom
components, target types and functions. An engine can retain an opaque RDF
reference beside its bounded compiled flags without materializing the original
string. Pattern parameters also retain Value by default, with an independent
fourth generic Pattern for compiled representations. For example,
Component<Value, Count, Flags, Pattern> allows four different types. Both
representations propagate through all declarations containing constraints.
The model does not parse regex syntax, compile patterns, or read payloads.
Consumers own compilation, resource accounting, and validation of RDF metadata.
Named roles use the fifth generic on components, shapes, parameters, custom
components, target types and functions. Paths use ShaclPath<Named>, and targets,
expressions, rules and parameter values propagate the same named type separately
from Value. Construction does not require conversion, cloning, display or
Serde traits. Display alone requires Named: AsRef<str>. Serialization and
checked loading use the selected named type's Serde contract; the strict
Iri<String> default continues to reject relative and invalid IRI strings.
Severity retains its independent checked IRI contract.
Serialization and RDF identity
The default terms use the shared rdf-structural-model foundation. Their
serialization supports JSON and non-self-describing binary formats such as
Postcard, including nested shapes, numeric lexical forms and directional
language messages. Blank nodes carry an explicit caller-assigned scope IRI;
use the same scope for intentionally shared identities and distinct scopes for
independent imports. This changes the default term API and serialized shape.
Applications still supply their own Value, Count and Flags without a
conversion layer. Their Serde support is conditional on those types. Model
support for RDF 1.2 triple terms and typed extensions does not establish SHACL
validator execution support for those features.
SPARQL and Advanced Features
| Declaration | Structural types |
|---|---|
| SELECT constraints, ASK/SELECT validators, result annotations | SparqlConstraint, SparqlValidator, ResultAnnotation |
| Query literals, prefix resources and imports | SparqlQuery, PrefixDeclaration, PrefixDeclarations |
| Custom components and parameter values | CustomConstraintComponent, CustomConstraint, Parameter, ParameterValues |
| Direct SPARQL targets and reusable target types | SparqlTarget, SparqlTargetType, CustomTarget |
| ASK/SELECT functions | ShaclFunction, SparqlSelectOrAsk |
| All seven AF node-expression forms, including nested path inputs | NodeExpression, ExpressionKind, ExpressionConstraint |
| Triple and SPARQL rules, conditions, order and deactivation | ShaclRule, RuleKind, TripleRule |
Declarations retain source nodes and RDF-valued messages. Parameter values are kept in full before an engine constructs query bindings. Prefix resources and imports are references, so shared declarations need not be copied into every query. Property shapes support targets as well as node shapes. Implicit class targets and custom target-type identifiers use the caller's RDF value type, preserving blank-node identity as well as named resources.
use ;
use ;
let blank = ;
let query = new
.with_prefixes;
let shape = new
.with_component;
assert_eq!;
Scope and memory
The crate exposes individual shapes and nested structural values. It does not
provide a document-sized Schema collection, so a parser can emit shapes one
at a time and let the caller decide whether to validate, serialize, persist,
or retain them. Collections inside a single shape represent that shape's
direct structural values; they are not a replacement for streaming an entire
input document.
This is a parsed structural model, not an RDF graph archive. Paths retain
their structure but not all RDF-list cell identities. Boolean parameters and
Core language strings are interpreted fields. Regex patterns and flags retain
their RDF values or caller-defined compiled representations. Callers that need
exact source triples or graph context must retain those separately. path_node
can retain a path's source root for result reporting. Display helpers are
human-readable labels, not RDF or SPARQL serialization.
The parser/consumer checks RDF node kinds, cardinality, query syntax, shape
references and expression cycles. This crate does not inspect opaque Value
payloads or certify a declaration as well-formed. Serde rejects unrecognized
fields on shapes and the new declarations, rather than discarding them.
Migrating from 2.x
Target::ImplicitClass, SparqlTargetType::id and CustomTarget::target_type
now hold Value rather than Iri<String>. Pass the corresponding RDF term,
including for named resources. Target::iri() and NodeShape::target_class_iris()
cover explicit IRI-valued targets; they do not inspect opaque implicit-class
terms. This is a breaking API and serialized-shape change for callers whose
RDF value representation differs from an IRI string.
Migrating from 1.x
This is a breaking API and Serde format change:
- Shape IDs, shape references,
Target::Node, and message builders now takeValue. Construct an RDF IRI/blank-node/literal term for those fields. PropertyShape::nameanddescriptionbecomenamesanddescriptions: vectors of RDF literals. Their builders append values, retaining languages.- Shape and rule
ordervalues useOption<Value>, replacing floating-point ordering on property shapes. Node shapes now also haveorder. ShaclRule::SparqlbecomesShaclRule::new(id, RuleKind::Sparql(query)). Query text is an RDF literal inSparqlQuery, with explicit prefix references.Severitysupports custom IRIs and is no longerCopy. Its accessors borrow the value. Invalid text returnsInvalidSeverityIri.- Shape
local_name()methods are removed because IDs need not be IRIs. Inspect the caller's term type and uselocal_namefor actual IRIs.Target::iri()now returnsOptionfor Core class/predicate targets. - Exhaustive matches on
Component,Target, andSeverityneed the new variants. Migrate stored Serde values explicitly; no legacy fields are ignored.
License
Licensed under either of:
- Apache License, Version 2.0
- MIT License
at your option.