Expand description
Umbrella Rust API for PurRDF.
This crate is the user-facing facade and the single dependency a downstream
needs: it re-exports the RDF 1.2 implementation surface from purrdf_rdf
at the root, and carries every other published crate under a stable module,
so anything a consumer legitimately imports is reachable from purrdf
alone — never by reaching into a sub-crate.
| Module | Sub-crate(s) |
|---|---|
| (root) | purrdf_rdf — core types, codecs, GTS/text adapters |
columnar | purrdf_columnar (five-table Parquet codec) |
gts | purrdf_gts (container engine) + the purrdf_rdf GTS adapter |
sparql | purrdf_sparql_eval + purrdf_sparql_algebra + purrdf_sparql_results |
shapes | purrdf_shapes (SHACL) |
shex | purrdf_shex (ShEx 2.1) |
entail | purrdf_entail (RDFS / OWL-RL / OWL-Direct / RIF entailment) |
datalog | purrdf_datalog (the semi-naive engine entail’s public types carry) |
geo | purrdf_geo (GeoSPARQL 1.1 geometry, geof: functions, query rewrite) |
text | purrdf_text (deterministic full-text search over RDF 1.2 literals) |
validate | purrdf_validate (SARIF 2.1.0 reporting boundary) |
slice | purrdf_slice |
viz | purrdf_rdf::viz |
xsd | purrdf_xsd |
iri | purrdf_iri |
events | purrdf_events |
Consumer-config types are surfaced at the root (SliceVocab,
Namespaces, StatementMetadataVocab) and unified behind a single
OntologyProfile a downstream builds once (see profile). The explicit
ontology-aware developer-schema contract (SchemaCompileRequest,
SchemaSurfaceMode, and compile_schema) is also available at the root.
§Example
Every step below goes through the purrdf facade alone — a downstream never
reaches into a sub-crate:
use purrdf::prelude::*;
// Parse RDF 1.2 Turtle into a frozen dataset through the umbrella facade.
let turtle = r#"
@prefix ex: <https://example.org/> .
ex:cat ex:says "meow" .
"#;
let dataset = purrdf::parse_dataset(turtle.as_bytes(), "text/turtle", None)
.expect("valid Turtle");
let view: &RdfDataset = &dataset;
assert_eq!(view.quad_count(), 1);
// The zero-dependency IRI leaf is reachable under a stable module.
let iri = purrdf::iri::parse("https://example.org/cat").expect("valid IRI");
assert_eq!(iri.as_str(), "https://example.org/cat");
// Parse a ShEx 2.1 schema and name a SPARQL results serialization — both
// from the same facade.
let schema = purrdf::shex::parse_shexc(
"PREFIX ex: <https://example.org/>\nex:Cat { ex:says . }",
None,
)
.expect("valid ShExC");
assert!(!format!("{:?}", purrdf::sparql::SparqlResultsFormat::Json).is_empty());
let _ = schema;§The document base
Both RDF legs of this facade take a document base, and it is the SAME parameter
on each: the trailing Option<&str> of parse_dataset and of
serialize_dataset_to_format. The Rust surface is therefore exactly as capable
as the Python, WebAssembly, and C ones — a consumer never drops to a sub-crate to
resolve or emit a relative IRI.
- Ingress.
parse_datasetresolves relative references against the supplied base for the syntaxes whose grammar admits them (NativeRdfFormat::admits_relative_iri). An in-document base (Turtle@base,xml:base, JSON-LD@context.@base) overrides the caller’s, per RFC-3986 §5.1. - Egress.
serialize_dataset_to_formatwrites the base directive and relativizes against it for the syntaxes that can express one (NativeRdfFormat::emits_base); the rest emit absolute IRIs. That is the only spelling those grammars admit, decided once from the format registry. - No base is a hard failure, never a fabricated one. PurRDF is handed bytes and
has no retrieval IRI, so it never invents a base from the filesystem or a URL.
A relative reference with nothing in scope fails with the shared diagnostic code
iri-relative-no-base; a supplied base that is not absolute fails on both legs.
The types for building and interpreting a base — iri::BaseIri,
iri::BaseScope, iri::BaseOrigin, and iri::IriError (whose
diagnostic_code owns those strings for
the whole workspace) — are reachable under iri, so naming one never costs a
second dependency.
use purrdf::{NativeRdfFormat, parse_dataset, serialize_dataset_to_format};
let base = "https://example.org/base/";
// Ingress: a relative subject resolves against the base.
let doc = "<rel> <https://example.org/p> <https://example.org/o> .\n";
let dataset = parse_dataset(doc.as_bytes(), "text/turtle", Some(base))?;
assert_eq!(dataset.quad_count(), 1);
// Egress: Turtle can express a base, so it is written and relativized against.
let turtle = serialize_dataset_to_format(&dataset, NativeRdfFormat::Turtle, Some(base))?;
let turtle = String::from_utf8(turtle.bytes).expect("utf-8");
assert!(turtle.contains("@base <https://example.org/base/> ."));
// N-Triples cannot, so the same base yields absolute IRIs rather than an error.
let nt = serialize_dataset_to_format(&dataset, NativeRdfFormat::NTriples, Some(base))?;
let nt = String::from_utf8(nt.bytes).expect("utf-8");
assert!(nt.contains("<https://example.org/base/rel>"));
// With nothing in scope the relative reference hard-fails; no base is invented.
let error = parse_dataset(doc.as_bytes(), "text/turtle", None).expect_err("no base");
assert_eq!(error.code, "iri-relative-no-base");Re-exports§
pub use profile::OntologyProfile;pub use profile::ReifierVocab;pub use reasoning::ClosureRelations;pub use reasoning::GovernedEntailment;pub use reasoning::QueryEntailment;pub use reasoning::QueryEntailmentPlan;pub use reasoning::ReasoningError;pub use reasoning::RelationRebuilder;pub use reasoning::query_with_entailment;pub use reasoning::query_with_entailment_governed;
Modules§
- backend
- Narrow purrdf backend traits (P2d).
- blank_
label - Exact label alphabets for the syntax this workspace emits – blank-node
labels, XML
NCNames, XML character data – plus the deterministic(label, scope)<-> token codec (encode_blank_label/decode_blank_label) every serializer and every text parser goes through, so an out-of-alphabet label never becomes an unreadable document and two distinct blank nodes never become one. - bundle
- The self-describing bundle resource layer (S3).
- capture_
support - Shared corpus-classification helpers for the native golden-capture binary.
- columnar
- Bidirectional, byte-deterministic five-table Parquet codec.
- content_
store - Content-addressed blob store for the self-describing bundle (S3).
- datalog
- The deterministic semi-naive Datalog engine (
purrdf_datalog) thatentailevaluates its calculi on. - dataset_
io - RDF text/bytes ingress into the frozen
RdfDatasetIR. - dataset_
view - The static, allocation-free read view over an RDF dataset (purrdf P2,
). See
docs/design/purrdf-backend-contract.md. - describe
- Per-subject subgraph extraction — the Symmetric Concise Bounded Description (SCBD) of a resource.
- diagnostic
- Structured diagnostics: severity, source/GTS locations, conversion losses,
and the
RdfDiagnosticrecord callers translate to their reporting layer. - entail
- Native, wasm-clean entailment (
purrdf_entail): RDFS / OWL-RL forward materialization plus the OWL-Direct and RIF entry points, over the frozen IR. - events
- The zero-dependency streaming RDF event model.
- fno
- Native FnO (W3C Function Ontology) typed model + serializer.
- geo
- GeoSPARQL 1.1 (
purrdf_geo): exact, float-free WKT and GeoJSON geometry, thegeof:function family registered onsparql’s scalar seam, and feature-level query rewrite registered on its property-function seam — every IRI supplied by the caller. - gts
- GTS: the container engine (
purrdf_gts) plus the RDF-level GTS adapter frompurrdf_rdf(read_graph,flattened_dataset_from_bytes, …). - gts_
certify - GTS streamable-compaction certificates (GTS-SPEC §10.1/§10.2, Task 5).
- gts_
compose - The pyo3-free GTS snapshot compose core (P6).
- gts_
dict_ vectors - The fixed sources and authoring recipes behind the frozen in-band-dictionary
corpus vectors (
vectors/30-dict-rawcontent.gts,vectors/31-dict-trained.gts,vectors/32-dict-rsyncable.gts,vectors/33-multi-dict.gts). - gts_
view - Rust-owned read-side view over a folded GTS graph.
- gts_
write - Write a frozen
RdfDatasetinto a deterministic GTS byte stream. - ir
- The immutable, value-interned RDF 1.2 dataset IR (C1).
- iri
- IRI parsing, resolution, and CURIE expansion/contraction.
- lookaside
- Structured non-triple material (
RdfLookaside) that travels with an RDF store: typed sidecar resources, metadata entries, segment/blob records, suppressions, opaque nodes, and signature records. - loss
- The machine-readable RDF↔GTS loss ledger (C0).
- model
- The owned RDF 1.2 value model: terms, literals (including base-direction literals), triples, quads, reifiers, and statement annotations.
- native_
codecs - Native RDF text codecs (S3).
- native_
quads - Native
RdfQuad⇄RdfDatasetconversions. - prelude
- The common umbrella surface, for
use purrdf::prelude::*;. - profile
- One consumer-config shape for every namespace-bound emitter.
- projections
- Deterministic graph/tabular/research-object projection foundations and codecs. Deterministic, caller-configured RDF 1.2 graph, tabular, dataset-description, and research-object projections.
- provenance
- Generic provenance sidecar for the immutable RDF 1.2 dataset (S2).
- reasoning
- Entailment-aware SPARQL orchestration over the native PurRDF engines.
- shapes
- SHACL shape support.
- shex
- ShEx 2.1 schema parsing, serialization, and validation.
- slice
- Native slice catalog and dataset-wrapper support.
- sparql
- SPARQL 1.1/1.2: parser + algebra (
purrdf_sparql_algebra), evaluator (purrdf_sparql_eval), and results serialization (purrdf_sparql_results). - sssom
- Native SSSOM (Simple Standard for Sharing Ontology Mappings) codec.
- statements
- Native OWL axiom-annotation ↔ RDF 1.2 statement codec — the lead writer.
- store
- Dataset/import capability flags (
RdfStoreCapabilities). - text
- Deterministic full-text search over RDF 1.2 literals (
purrdf_text): an in-memory inverted index, exact fixed-point BM25 ranking, and the relations a caller registers onsparql’s property-function seam under its own IRIs. - turtle
- Native RDF 1.2 Turtle emitter for
crate::storestores. - turtle_
normalize - A canonical, review-friendly Turtle serializer over the purrdf IR.
- turtle_
render - The canonical, review-friendly Turtle renderer over the purrdf IR — the oxigraph-free half of the on-disk normalizer.
- ustar
- Shared USTAR (tar) codec — byte-deterministic writer + reader.
- validate
- The SARIF 2.1.0 reporting boundary (
purrdf_validate): validate a shapes+data pair to a source-traced, byte-deterministic SARIF log. - viz
- Statement-centric RDF 1.2 visualization projection and SVG export support.
- xsd
- XSD datatype value spaces and operations.
Macros§
Structs§
- Artifact
Id - Opaque id for a packaged artifact within a unit (module file, shapes file, mapping, query, …). Runtime-only (S0.5).
- Artifact
Identity - Exact identity of a model, engine, tokenizer, or manifest.
- Artifact
Index - Index of
ArtifactRecords with lookup byArtifactId, by logical path, and byUnitId. - Artifact
Interner - Interner for
ArtifactIds — maps a logical artifact path to a dense numeric id. The path is a string the caller controls (e.g. a repo-relative file path or a content-addressed digest); the kernel does not interpret it. - Artifact
Record - One packaged artifact: a content-addressed reference into the
ContentStore, with no inline payload bytes. - Artifact
Root - Integrity root over the canonical PURREMB header and section directory.
- Assertion
Occurrence - One physical assertion: the pair
(unit, artifact)that asserted the quad identified byquad(aQuadHandleinto the associatedRdfDataset). - Attribution
- A structured attribution: which compilation unit played which role in producing a finding, derivation, or SHACL result (S0.3 / §9).
- Blank
Scope - Blank-node scope. Participates in the interning key (C0.2): two blank nodes
from different scopes are distinct even with the same label; two blank nodes in
the same scope with the same label are the same node.
0= default/global scope;> 0= a per-segment scope assigned by the streaming importer. - Budget
Exceeded - The n-degree search’s call/permutation budget (
RDFC_CALL_LIMIT) was exhausted before the dataset canonicalized — a pathologically symmetric blank graph (adversarial input, not a legitimate large dataset: a non-symmetric graph of any size stays well under budget). Returned bytry_canonicalize/try_canonicalize_withinstead of the panic thatcanonicalize/canonicalize_withraise for trusted callers. - Canonical
Metadata Input - Complete typed input for the eight non-matrix PURREMB metadata sections.
- Canonical
Metadata Sections - Canonically encoded non-matrix sections supplied to both writer paths.
- Canonicalized
- The result of canonicalizing a dataset.
- Certified
Purrpck Source - Independently certified attachment to one exact
.purrpckbyte string. - Chunking
Contract Id - Identity of the exact chunking-stage contract.
- Compiled
Json LdContext - Immutable compiled JSON-LD 1.1 active and inverse context.
- Construct
View Config - Mandatory bounds and query text for a whole-dataset SPARQL CONSTRUCT view.
- Construct
View Projection - Materialized result of one bounded whole-dataset CONSTRUCT view.
- Content
Digest - A content id: the SHA-256 digest of a blob’s bytes.
- Content
Store - A content-addressed blob store: bytes keyed by their SHA-256
ContentDigest. - Contract
Extension - One caller extension field retained in a canonical contract.
- Corpus
Target - Corpus-manifest subject.
- Croissant
Config - Mandatory caller-owned configuration for the Croissant 1.1 codec.
- Croissant
Vocabulary - Complete caller-owned compact-term binding for Croissant.
- Csvw
Cell - One annotated table cell.
- Csvw
Column - One column description in a CSVW table schema.
- Csvw
Config - Mandatory identity and resource policy for CSVW processing.
- Csvw
Context - Caller-owned JSON-LD context identity and compact-IRI prefix map.
- Csvw
Datatype - CSVW datatype and its value-space facets.
- Csvw
Dialect - A normalized CSVW dialect.
- Csvw
Exact Projection - Exact, lossless RDF 1.2 → CSVW result.
- Csvw
Exact Read Outcome - Exact CSVW → RDF 1.2 result.
- Csvw
Foreign Key - A table-schema foreign-key constraint.
- Csvw
Inherited Properties - Properties inherited by table, schema, and column descriptions.
- Csvw
Input - Complete in-memory resource set for one CSVW operation.
- Csvw
Mapped Table Group - Typed result that a caller-owned RDF-to-table mapping must produce.
- Csvw
Numeric Format - A CSVW numeric-format object.
- Csvw
Read Outcome - Result of processing a complete CSVW resource package.
- Csvw
Reference - A foreign-key reference target.
- CsvwRow
- One annotated table row.
- Csvw
Schema - A normalized CSVW table schema.
- Csvw
Table - One annotated CSVW table and its parsed rows.
- Csvw
Table Group - A normalized CSVW table group.
- Csvw
Terms Column - One caller-owned RDF predicate mapped to one ordered CSVW column.
- Csvw
Terms Config - Complete mandatory configuration for the write-only
csvw-termsprofile. - Csvw
Terms Identity Column - Visible subject-identity column shared by every row in one table.
- Csvw
Terms Limits - Portable execution ceilings specific to curated wide tables.
- Csvw
Terms Projection - Curated CSVW package, normalized table model, and complete runtime ledger.
- Csvw
Terms Report - Deterministic execution counts for one curated terms projection.
- Csvw
Terms Selector - Caller-supplied RDF-type and subject-namespace membership test for one table.
- Csvw
Terms Table - One curated entity table and its complete mapping policy.
- Csvw
Transformation - A CSVW transformation description retained by the annotated model.
- Csvw
Value - A normalized value produced by parsing one CSV cell.
- Csvw
Vocabulary - Caller-supplied RDF namespaces used by the CSVW conversion algorithm.
- Csvw
Warning - Deterministic non-fatal CSVW diagnostic.
- Csvw
Write Outcome - Result of deterministically writing one normative CSVW table group.
- Csvw
Write Plan - Mandatory mapping from resource identities to safe package paths.
- Data
Cite Config - Mandatory caller-owned DataCite 4.6 schema and semantic configuration.
- Data
Cite Controlled Values - Caller-selected DataCite 4.6 controlled values and identifier policy.
- Dataset
Diff - A structural diff between two datasets, for test diagnostics. Counts only; the
blank-aware verdict is
datasets_isomorphic. - Dataset
Provenance - The provenance sidecar for one
RdfDataset. - Dataset
Sink - An
RdfEventSinkthat folds a permissive ingestion event stream into a frozenRdfDataset, tolerant of forward references (two-phase; see the module docs). - Dcat
Config - Mandatory caller-owned DCAT 3 configuration.
- Dcat
RdfConfig - Mandatory output syntax and source policy for the
dcat-rdfprofile. - Dcat
RdfMapping Config - Mandatory target-core vocabulary and output bound for mapped DCAT RDF.
- Dcat
Vocabulary - Complete caller-owned compact-term binding for the DCAT application profile.
- Derived
Index - One opaque, rebuildable derived index and its exact guard commitment.
- Document
Target - External UTF-8 document subject.
- Effective
Matrix View - A matrix paired with one compatible fixed or Matryoshka projection.
- Effective
Prefix - One declared effective prefix in an embedding family.
- Effective
Space - One effective vector space in a fixed or Matryoshka family.
- Effective
Space View - Borrowed view of one effective vector-space record.
- Embedding
Builder - Canonical in-memory PURREMB builder.
- Embedding
Family - Derived, canonical representation of one embedding family.
- Embedding
Family Contract - Complete generation contract for one fixed or Matryoshka embedding family.
- Embedding
Stream Writer - Bounded-memory canonical writer over an initially empty seekable output.
- Embedding
Target - Canonical target plus optional retained identity bytes and pack-local ordinal.
- Embedding
Verification Report - Counts and resident proof produced by full artifact verification.
- Embedding
View - Bounds-safe borrowed view over one structurally canonical PURREMB artifact.
- Encoded
Artifact - Result of canonical in-memory file assembly.
- Extension
Section - One caller extension section retained byte-for-byte by the writer.
- Extension
Target - Caller-defined extension target.
- External
Binding - One exact external-artifact binding with its derived identity.
- External
Binding Contract - Caller-supplied semantics for an exact external artifact.
- External
Binding Id - Identity of one exact external-artifact binding.
- External
Binding Identity - Inputs to the external-binding identity fold.
- External
Binding View - Borrowed external-artifact binding record.
- External
Contract Digest - Digest of one generic external-artifact contract.
- F32Scalars
- Portable little-endian
f32decoder that rejects non-finite values lazily. - F64Scalars
- Portable little-endian
f64decoder that rejects non-finite values lazily. - Family
Contract Digest - Digest of one canonical vector-family contract block.
- Family
Id - Identity of a complete embedding family.
- Family
View - Borrowed view of one vector-family record.
- FnFunction
- One
fno:Functionnode (always typedfno:Function; any additionalrdf:typeIRIs — e.g. the consumer’s projection-function class for the projection catalog — come fromFnFunction::kind_types). - FnImpl
- One
fno:Implementationnode (one per profile.rq). - FnMapping
- One
fno:Mappingnode linking a function to one profile’s implementation. - FnOutput
- The
fno:Outputnode of a function. - FnParam
- One globally-deduped
fno:Parameternode. - FnParam
Mapping - One
fnom:PropertyParameterMapping(a parameter ↦ a SPARQL variable). - FnReturn
Mapping - One
fnom:DefaultReturnMapping(the function output ↦ a SPARQL variable). - FnoCatalog
- The fully-resolved FnO catalog the
purrdf-sliceemitter assembles and serializes here. - Frictionless
Config - Mandatory caller-owned Frictionless Data Package v1 configuration.
- Frozen
Dataset Source - An
RdfEventSourcethat replays an already-frozenRdfDatasetinto anyRdfEventSink: atermevent per term inTermIdorder (declares-before- reference), then quad / reifier / annotation events. - GtsBundle
- The frozen RDF 1.2 hot graph plus its out-of-band envelope.
- GtsCodec
Backend - The native codec backend: a codec-only
RdfParserBackend+RdfSerializerover thepurrdf-gtstext codecs. Holds no state and references no oxigraph Store. - Handle
Entry - A typed handle: a pipeline-side payload
Hpaired with the PINNEDContentDigestof the named graph it projects. - Index
Coordinates - Exact typed coordinates guarded by one opaque index.
- Index
Guard Contract - Complete canonical contract guarding one opaque derived index.
- Index
Guard Digest - Digest of one opaque derived-index guard contract.
- Index
Guard View - Borrowed opaque derived-index guard and optional inline payload.
- IndexId
- Identity of one guarded opaque derived index.
- Index
Identity - Inputs to the opaque derived-index identity fold.
- Index
Loss Contract - Explicit approximation and vector-loss contract for an opaque index.
- Json
LdContext Limits - Fixed resource ceilings for context decoding and compilation.
- Json
LdContext Registry - Immutable collection of caller-supplied context documents keyed by absolute IRI.
- Json
LdSerialize Options - Closed version-1 JSON-LD/YAML-LD serialization request.
- Json
LdTerm Definition - Compiled definition for one term or keyword alias.
- Json
LdTerm Selection - Ordered inverse-context preferences for one IRI-compaction decision.
- L2F32
Scalars - Allocation-free deterministic-L2
f32projection iterator. - L2F64
Scalars - Allocation-free deterministic-L2
f64projection iterator. - Loss
Entry - One enumerated conversion loss between two representations.
- Loss
Ledger - An ordered, deterministic set of
LossEntryfor one conversion direction (or the combined matrix). - LpgAnnotation
- Exact RDF 1.2 statement annotation carried by the canonical LPG model.
- LpgConfig
- Mandatory policy and resource boundary for the canonical LPG mapping.
- LpgEdge
- Canonical directed LPG edge with exact RDF statement identity.
- LpgExecution
Limits - Mandatory fail-fast execution bounds for RDF-to-LPG mapping.
- LpgGraph
- Canonical deterministic LPG plus complete RDF 1.2 reversal sideband.
- LpgLabel
- One RDF type-like statement lowered to a native LPG label.
- LpgLift
Outcome - Result of canonical LPG→RDF lifting.
- LpgNode
- Canonical LPG node with exact RDF term identity.
- LpgPackage
Projection - A direct RDF projection into one deterministic LPG carrier package.
- LpgProgress
- Monotonic progress snapshot for mapping and artifact emission.
- LpgProjection
- Result of RDF→LPG projection.
- LpgProjection
Report - Exact counters from one RDF-to-LPG mapping.
- LpgProperty
- One RDF literal statement lowered to a native LPG property.
- LpgRdf
Quad - Exact RDF 1.2 statement identity retained beside a native LPG construct.
- LpgReifier
- Exact RDF 1.2 reifier binding carried by the canonical LPG model.
- LpgStream
Projection - Result of direct RDF-to-artifact-sink LPG projection.
- Matrix
Commitment - A fully derived stored-matrix commitment used by the streaming writer.
- Matrix
Content Digest - Domain-separated digest of one stored matrix’s exact scalar bytes.
- Matrix
Id - Identity of one stored matrix over a family and target set.
- Matrix
Input - One unordered matrix accepted by
EmbeddingBuilder. - Matrix
Row - One target-associated row accepted by the unordered in-memory builder.
- Matrix
View - Borrowed authoritative dense matrix.
- Mutable
Dataset - A copy-on-write mutable RDF dataset (purrdf P5). Branches cheaply off a
shared frozen base; records mutations as an append delta + a suppression set; and
compacts back to a frozen
RdfDatasetviafreeze. - Namespaces
- The caller-supplied namespace table driving ALL IRI compaction,
$defskeying, and@typediscrimination — for BOTH the schema emitter (compile) and the instance projector (crate::instance). - OboDomain
Range Axiom - Aggregated domain/range declaration for one property.
- OboEdge
- Basic OBO Graphs edge.
- OboEquivalent
Nodes Set - Set of mutually equivalent named nodes.
- OboExistential
Restriction - Named existential restriction in one logical definition.
- OboGraph
- One OBO Graphs 0.3.2 graph.
- OboGraph
Document - OBO Graphs 0.3.2 graph document.
- OboGraphs
Config - Mandatory graph identity, vocabulary, and resource bounds for OBO Graphs.
- OboGraphs
Projection - Result of projecting an RDF 1.2 dataset into the OBO Graphs 0.3.2 view.
- OboGraphs
Vocabulary - Complete caller-supplied semantic vocabulary for RDF→OBO Graphs 0.3.2.
- OboLogical
Definition Axiom - Named-class equivalence to an intersection of genera and existentials.
- OboMeta
- OBO Graphs 0.3.2 metadata, including nested axiom metadata.
- OboMetadata
Roles - Caller-owned OBO metadata roles.
- OboNode
- Basic OBO Graphs node.
- OboOwl
Roles - Caller-owned RDFS and OWL semantic roles used by the projection.
- OboProperty
Chain Axiom - One OWL property-chain axiom.
- OboProperty
Value - One metadata property value in the 0.3.2 object model.
- OboRdf
Roles - Caller-owned RDF and XML Schema roles used by the OBO Graphs projection.
- OboSynonym
- One OBO synonym property value.
- OboXref
- One OBO cross-reference property value.
- Offline
Json LdContext - Caller-owned, locally interpreted JSON-LD context.
- OkfBody
Section - Caller-authored Markdown body section backed by one or more predicates.
- OkfBundle
- A deterministic, validated in-memory OKF Markdown bundle.
- OkfCategory
- Caller-authored category metadata and classifier.
- OkfConcept
Selector - Caller-supplied type-set and IRI-prefix classifier for one OKF category.
- OkfConfig
- Mandatory caller-owned OKF vocabulary and frontmatter profile.
- OkfError
- A typed hard failure from OKF configuration, parsing, lifting, or writing.
- OkfField
Mapping - Predicate set, cardinality, and value policy for one output field.
- OkfFrontmatter
Mappings - Complete mapping for standard and producer-defined OKF frontmatter.
- OkfGeneration
Config - Complete mandatory configuration for the write-only
okf-termsprojection. - OkfGeneration
Report - Deterministic execution counts for one OKF terms projection.
- OkfIndex
Config - Caller-authored root-index and in-band projection-fidelity prose.
- OkfLink
Section - Caller-authored Markdown link section backed by RDF predicates.
- OkfProjection
- Caller-curated OKF bundle, filesystem-free package, counts, and located losses.
- OkfRead
Outcome - Report from lifting an OKF bundle through an RDF event sink.
- OkfWrite
Outcome - Result of projecting an RDF 1.2 dataset into an OKF Markdown bundle.
- OkfWriter
- Event receiver for the RDF-dataset → OKF projection.
- Origin
SetId - Opaque id for an interned set of origins. Two quads with the same set of
(UnitId, ArtifactId)pairs share anOriginSetId. Runtime-only (S0.5). - Origin
SetInterner - Interner for
OriginSetIds — maps a canonical sorted set of(UnitId, ArtifactId)pairs to a dense numeric id. - Pack
Builder - The offline factory writer: assembles a self-contained, byte-deterministic
pack file from an
RdfDataset. See the module docs for the exact on-disk layout. - Pack
Digest - A verified SHA-256
purrdf-rdfc12digest: the output ofverify_packon success. - PackId
- The
DatasetViewid aPackView-backed read mints: a thin, niche-optimized wrapper around the pack dictionary’s unified [PackTermId] (see the module docs). Meaningful only within thePackViewthat resolved it (C0.8) — a durable identifier must resolve the term to its RDF value rather than retain aPackId. - Pack
View - The zero-copy, borrowed reader over
PackBuilder::build_bytes’s output. Owns the decoded [PackDict] (an arena the dictionary’s PFC sections are decompressed into once, at open time) and borrows the bitmap-triples and side-table sections directly from the input buffer — see the module docs for the exact on-disk layout and the fail-closed verificationfrom_bytesperforms. - Page
Fault - A page could not be materialized as part of the requested snapshot.
- Page
Generation - The immutable provider snapshot to which page translations and byte metadata belong.
- PageId
- A dense page ordinal. Pages of a
PagedDatasetare numbered0..page_countand iterated in ascendingPageIdorder. - Page
Materialization - One atomic page-materialization result.
- Page
Part - One page’s pre-built seal metadata, the unit of
PagedDataset::from_parts/to_parts. - Page
Translation - The local↔global term-id map for a single page of a
PagedDataset. - Paged
Dataset - A reference demand-paged dataset composing many frozen
RdfDatasetpages into one logicalDatasetViewkeyed onGlobalTermId. - Paged
Quad Overlap - The offending quad of a
PagedFreezeError::QuadOverlaprefusal: the two pages that share it, which composed stream it belongs to, and the quad resolved to dataset-independentTermValues. - Paged
Query Evidence - Deterministic evidence accumulated by one paged query operation.
- Paged
Query Limits - Exact resource ceilings for one
PagedQueryView. - Paged
Query View - An operation-local, fallible
DatasetViewover a sealedPagedDataset. - Parse
Options - Runtime options for
parse_dataset_with. - Parse
Outcome - Everything one parse of one document produced.
- Pipeline
Bundle - The pipeline carrier: the frozen hot graph plus its out-of-band material and a typed-handle lane.
- Projection
Archive - Deterministic USTAR projection plus its always-computed runtime loss ledger.
- Projection
Commitment - A fully derived effective-projection commitment.
- Projection
Content Digest - Domain-separated digest of one effective matrix projection.
- Projection
Error - Typed hard failure from a graph or tabular projection.
- Projection
Id - Identity of one effective matrix projection.
- Projection
Lift - Dataset reconstructed from a bidirectional projection carrier.
- Projection
Limits - Mandatory resource bounds shared by projection writers and readers.
- Projection
Package - A deterministic, validated, filesystem-free projection artifact package.
- Projection
Package Sink - In-memory adapter used by the materializing
ProjectionPackageAPIs. - Projection
Spec - One effective leading-prefix projection declared for a matrix family.
- Projection
View - Borrowed effective projection record.
- Quad
Handle - A handle identifying a pushed quad by its dense (deduplicated) ordinal, used to
attach a source location sparsely. Like
TermId, it is local to one frozen dataset and is not persistent or merge-stable. - QuadIds
- A small
Copyquad row in term ids, for ID-native consumers.g == Noneis the default graph. - Quad
Pattern Cursor - An owned, row-materialization-free cursor over one indexed quad pattern.
- QuadRef
- A borrowed, resolved quad view: each position is a
TermRefborrowing into the dataset’s term table. No allocation, no clone per quad. - Quad
Values - An owned, dataset-independent quad value — the argument type of
DatasetMut::insert/remove/contains. - RdfAnnotation
- RDF 1.2 statement annotation.
- RdfAnnotation
Target - RDF 1.2 annotation target.
- RdfBlob
Origin - Where a blob’s payload bytes can be fetched from.
- RdfBlob
Record - A content-addressed reference to a blob that travels with an RDF store.
- RdfBundle
- The self-describing, repo-free bundle: dataset + provenance + unit catalog + artifact index + the actual blob bytes.
- RdfDataset
- The immutable, frozen RDF 1.2 dataset. Constructed only via
RdfDatasetBuilder::freeze. - RdfDataset
Builder - The fallible builder that interns terms, accumulates structure, and freezes
into an immutable
Arc<RdfDataset>. - RdfDataset
Target - Certified RDF dataset subject.
- RdfDescription
Projection - One frozen RDF description graph and its deterministic packaged serialization.
- RdfDiagnostic
- Structured RDF diagnostic. Callers translate this to their reporting layer.
- RdfEnvelope
- Out-of-band material that travels with an
RdfDatasetbut is not part of the hot graph (C0.6). - RdfGraph
Target - Default or named RDF graph target.
- RdfLiteral
- An RDF literal, including RDF 1.2 language direction when available.
- RdfLocation
- Concrete or logical location attached to an RDF diagnostic.
- RdfLookaside
- Structured non-triple material that travels with an RDF store.
- RdfLookaside
Resource - A typed sidecar resource such as SHACL, ShEx, docs, logic, schemas, or queries.
- RdfMetadata
Entry - A scoped key/value metadata entry carried alongside the triples.
- RdfOpaque
Node Record - A frame preserved as an opaque node: its content was not decoded, only its identity and public envelope survive.
- RdfParse
Request - RDF parser request. Formats are named by media type or local format id at the contract boundary so the core trait does not leak an oxigraph enum.
- RdfQuad
- Owned RDF 1.2 quad with optional adapter/source context.
- RdfReifier
- RDF 1.2 reifier binding.
- RdfReifier
Target - RDF 1.2 reifier-binding target.
- RdfSegment
Record - Per-segment facts recorded from the source GTS file.
- RdfSerialize
Request - RDF serializer request. Formats are media types/local ids for the same reason
as
RdfParseRequest: the core trait must not expose an oxigraph enum. - RdfSignature
Record - A frame signature record.
- RdfStatement
Target - RDF 1.2 statement target.
- RdfStore
Capabilities - Capability flags exposed by an RDF dataset/import boundary.
- RdfSuppression
Record - A
suppressdirective (GTS §11) carried through verbatim; decode its targets withRdfLookaside::suppression_targets. - RdfTriple
- Owned RDF 1.2 triple. The model keeps triple-term subjects representable; downstream adapters decide whether a target store can encode them.
- Rdfc
Digest - Claimed or verified RDFC SHA-256 bytes carried by PURREMB metadata.
- Relation
Range - Iterator over one target’s contiguous relation range.
- Relation
View - Borrowed structural relation.
- Research
Activity - Provenance activity connected to the research object.
- Research
Agent - Person, organization, or software agent used by a research object.
- Research
Checksum - Algorithm/value checksum pair.
- Research
Dataset - Dataset-level research-object metadata and entity references.
- Research
Field - Field definition in a Croissant-compatible record set.
- Research
Object Config - Shared source-vocabulary, identity, and resource policy.
- Research
Object Identity - Caller-owned data identity policy shared by all research-object profiles.
- Research
Object Model - Canonical typed semantic pivot shared by every research-object codec.
- Research
Object Package Projection - Native-profile projection result before USTAR encoding.
- Research
Object Policy - Mandatory resource policy for common research-object interpretation.
- Research
Object Projection - Common semantic projection and its always-computed runtime losses.
- Research
Object Read Outcome - Native-profile reader result after caller-vocabulary RDF lift.
- Research
Object Roles - Complete caller-owned RDF vocabulary binding for research objects.
- Research
Record Set - Structured record set with deterministic inline JSON rows.
- Research
Resource - File, distribution, or other data resource.
- Research
Text - RDF literal identity retained by the common research-object model.
- Reserved
Vocabulary - The input dataset carries an IRI in the profile’s
RESERVED_NAMESPACE, which canonicalization refuses rather than lower alongside its own sentinels. - Resident
Embedding Certificate - Opaque proof that one exact resident byte range passed full verification.
- RoCrate
Assets - Bounded payload artifacts supplied by reference to the RO-Crate engine.
- RoCrate
Config - Mandatory caller-owned configuration for RO-Crate 1.3.
- RoCrate
Vocabulary - Complete caller-owned compact-term binding for RO-Crate.
- Schema
Class Property Coverage - One catalogued property’s decision for one eligible class.
- Schema
Compilation - Ontology-aware compilation output.
- Schema
Compilation Key - Compiler-owned cache identity for one complete schema request.
- Schema
Compile Request - Complete input contract for ontology-aware schema compilation.
- Schema
Coverage Provenance - One source axiom supporting a schema-surface decision.
- Schema
Coverage Report - Deterministic audit manifest for ontology property coverage.
- Schema
Property Coverage - Aggregate coverage for one ontology-declared property.
- Section
Key - The canonical sort key for one section-directory entry.
- Section
View - One borrowed PURREMB directory entry and its exact section bytes.
- Segment
Unit Map - A set-valued mapping between GTS segments and compilation units (S0.7).
- Serialize
Options - Policy options for
serialize_dataset_with— the egress mirror ofParseOptions. - Serialize
Outcome - Outcome of serializing an
RdfDatasetto a concrete RDF format through the native codecs (universal transcoder helper, ported onto the native path). - Skos
Class Roles - Caller-owned RDF type and SKOS class roles.
- Skos
Config - Mandatory identity, vocabulary, graph, and resource policy for RDF→SKOS.
- Skos
Documentation Roles - Caller-owned SKOS documentation-property roles.
- Skos
Label Roles - Caller-owned SKOS lexical-label and notation roles.
- Skos
Projection - Result of projecting an RDF 1.2 dataset into one SKOS concept-scheme view.
- Skos
Relation Roles - Caller-owned SKOS hierarchy, mapping, membership, and top-concept roles.
- Skos
Source Roles - Complete caller-owned source interpretation for the RDF→SKOS projection.
- Skos
Target Roles - Complete caller-owned target vocabulary for the emitted SKOS view.
- Slice
Vocab - The caller’s slice-framework vocabulary: a namespace all framework term IRIs
are derived from by concatenation (
{ns}{localName}), the set of namespaces the caller’s slices mint ontology terms into, plus the CURIE prefix name used when emitting prefixed names. - Small
Vec - A
Vec-like container that can store a small number of elements inline. - Source
Verification Report - Evidence returned after verifying the attached source pack.
- Source
View - Exact source-pack attachment carried by the
SOURCEsection. - Span
Table - Opt-in mapping from a data-graph subject to the source
Positionwhere it was first asserted, plus the ordered list of every recorded(subject, position). - Sparql
Request - SPARQL operation request.
- Sssom
Column Layout - A validated TSV column declaration retained from a parsed SSSOM mapping set.
- Sssom
Diagnostic - A single validation diagnostic, mirroring the sssom-py golden record shape
{severity, type, message, instance, check}.codecarries the golden’stypestring;checkcarries the originating check name. - Sssom
Mapping - A single SSSOM mapping (one TSV data row).
- Sssom
Mapping Set - A parsed SSSOM mapping set: header metadata, mappings, and document envelope.
- Sssom
Meta - The SSSOM metadata header.
- Sssom
SetComment - One validated, set-scoped comment in the SSSOM document envelope.
- Stage
Implementation - Complete identity and parameters for one applied pipeline stage.
- Statement
Metadata Vocab - The CALLER-SUPPLIED statement-metadata reification vocabulary the JSON-LD-star downcast emits.
- Subset
Page Provider - A provider exposing a subset of another provider’s pages under fresh dense ids.
- Target
Id - Stable identity of one embedding target.
- Target
Identity Digest - Digest of one target kind’s canonical identity block.
- Target
Relation - Built-in or caller-defined structural relation.
- Target
Set - Canonical, nonempty target row set shared by one or more matrices.
- Target
SetId - Identity of one sorted, duplicate-free target row set.
- Target
SetView - Borrowed, nonempty target row set.
- Target
View - Borrowed canonical target record.
- TermId
- Opaque term identity, LOCAL to one frozen
RdfDataset. Deliberately NOTSerialize/Deserialize, not merge-stable, not meaningful across datasets (C0.8). Any consumer needing a durable identifier MUST resolve the term to its RDF value rather than retaining aTermId. - Text
Chunk Target - Content-addressed document chunk with byte and scalar coordinates.
- TlvEntry
Ref - Borrowed framing for one canonical TLV entry.
- TlvIter
- Allocation-free iterator over a structurally validated canonical TLV block.
- Token
Span - Family-scoped tokenizer span for a document or chunk target.
- Token
Span View - Borrowed family-scoped token span.
- Transport
Error - A transport decode failure: the encoding that was applied and why it failed.
- Transport
Reader - A
Readstream whose transport wrapper is decoded INCREMENTALLY as the consumer pulls, rather than inflated into one buffer first. - Unit
Catalog - Maps each
UnitIdto itsUnitMetadata. - UnitId
- Opaque id for a compilation/source unit (file set, import, generated graph, or runtime data input). Runtime-only: MUST NOT enter persistent serialization, cache keys, or derivation hashes (S0.5).
- Unit
Interner - Interner for
UnitIds — maps a logical unit name to a dense numeric id. - Unit
Metadata - Metadata describing one compilation unit (the kernel-generic projection of a slice / root ontology / import / generated graph / runtime input).
- Vector
Space Id - Identity of one effective dimension and prefix policy in a family.
- Void
Config - Complete deterministic VoID dataset-description policy.
- Void
Dataset Prefix - One deterministic IRI-prefix to dataset identity binding.
- Void
Execution Limits - Explicit compute and materialization bounds for VoID generation.
- Void
External Link Mapping - Source-to-target predicate mapping for metadata-graph external IRI links.
- Void
Source Roles - Complete caller-owned source predicate binding for VoID extraction.
- Void
Static Statement - One caller-authored statement whose subject is the described dataset IRI.
- Void
Vocabulary - Complete caller-owned target vocabulary for VoID output.
Enums§
- Applied
Stage - Explicit pipeline-stage state.
- Artifact
Identity Kind - Artifact cardinality carried by
ArtifactIdentity. - Attribution
Role - The role of a compilation unit in a structured attribution (S0.3 / §9).
- Bundle
Error - A hard error from
RdfBundle::load. The loader never silently repairs; every malformed structure is a typedErr. - Canon
Error - Why canonicalization refused.
- Canon
Hash - The RDFC-1.0 hash algorithm. SHA-256 is the default; SHA-384 is the spec’s
alternative (RDFC-1.0 §3, exercised by W3C suite
test075). EXTEND beyondoxrdf, which only offered SHA-256. - Content
Store Error - An error raised while validating or accessing a content-addressed blob.
- Croissant
Role - Semantic term required by the Croissant 1.1 adapter.
- Csvw
Action - Explicit CSVW processing entry point selected by the host.
- Csvw
Datatype Format - String or numeric-object datatype format.
- Csvw
Mode - RDF conversion mode defined by the CSVW Recommendation.
- Csvw
Table Direction - Direction in which a table is presented.
- Csvw
Terms Cardinality - Cardinality and deterministic multi-value encoding for one column.
- Csvw
Terms Graph Selection - Explicit RDF graph scope used to discover rows and column values.
- Csvw
Terms Value Mode - Exact RDF object kind accepted by a curated column.
- Csvw
Text Direction - CSVW text direction for a column value.
- Csvw
Trim - Whitespace trimming policy from a CSVW dialect description.
- Csvw
Warning Kind - Stable severity for a non-fatal CSVW metadata or row diagnostic.
- Dcat
RdfSource - Complete source policy for native DCAT RDF.
- Dcat
Role - Semantic compact term required by the DCAT 3 application-profile adapter.
- Digest
Kind - A digest or typed identity that failed validation.
- Dimensionality
Policy - Fixed or Matryoshka dimensionality contract.
- Distance
Metric - Distance semantics for compatible vectors.
- Effective
F32Row - Logical
f32prefix values, raw or deterministically L2-normalized. - Effective
F64Row - Logical
f64prefix values, raw or deterministically L2-normalized. - Embedding
Error - A fail-closed PURREMB format, identity, or verification error.
- Embedding
Integrity - Integrity evidence currently associated with a borrowed view.
- Embedding
Write Error - A PURREMB streaming-write failure.
- External
Scope - Typed scope of one exact external-artifact binding.
- External
Scope Kind - Semantic type of an external-artifact binding scope.
- Graph
Match - How a pattern query matches the graph slot of a quad.
- Graph
Match Value - How a write-side pattern query matches the graph slot of a quad — the
value-based twin of
GraphMatch. - Index
Build Determinism - Declared determinism of an opaque index payload.
- Index
Determinism - Declared index-build determinism.
- Index
Payload Storage - Inline or detached storage for exact opaque index bytes.
- Index
Storage - Opaque index storage mode.
- Index
UseRole - Intended query-stage role of one index.
- IriError
- Why an IRI/URI string (or a reference-resolution / CURIE operation) failed.
- Json
LdContainer - One JSON-LD 1.1 container mapping component.
- Json
LdDirection - Base direction carried by a JSON-LD 1.1 context or term definition.
- Json
LdNullable - Explicit nullable mapping in a JSON-LD term definition.
- Json
LdSerialize Mode - Explicit output mode for configured JSON-LD/YAML-LD serialization.
- Json
LdTerm Selection Kind - Inverse-context branch used while selecting a compact term.
- Json
LdType Mapping - Type coercion attached to a compiled JSON-LD term.
- Lift
Profile - Closed set of profiles accepted by the lift operation.
- LpgGraph
Context - Graph placement carried beside one RDF-origin LPG record.
- LpgIri
Selection - Exact allow/deny selection over absolute IRIs.
- LpgNamed
Graph Selection - Exact include/exclude selection over RDF named-graph terms.
- LpgProgress
Phase - Stable phase for one RDF-to-LPG mapping/package operation.
- LpgProperty
Atom - Native scalar projection of one RDF literal.
- LpgScope
- Mandatory RDF input scope for LPG projection.
- Native
RdfFormat - The RDF text serializations the native codec backend parses and serializes via the
purrdf-gtscodecs. This is the codec-selector enum that replacesoxigraph::io::RdfFormat’s use as a router across the workspace. - OboNode
Type - OBO Graphs node kind.
- OboProperty
Type - OBO Graphs property kind.
- OkfBody
Style - Structural layout for values in a body or link section.
- OkfBody
Value Mode - How mapped body values are represented before Markdown layout.
- OkfCardinality
- Output cardinality and missing-value policy for one mapped field.
- OkfGraph
Selection - Explicit RDF graph scope used for concept discovery and mapped values.
- OkfLink
Path Style - Link-destination policy for selected concept documents.
- OkfLink
Style - Structural layout for one set of Markdown links.
- OkfLink
Target Mode - Which link targets a section renders.
- OkfPath
Strategy - Deterministic bundle path identity strategy.
- OkfResource
Mapping - Caller-owned policy for the standard
resourcefrontmatter field. - OkfTerm
Rendering - Total textual rendering for arbitrary RDF 1.2 term values.
- OkfValue
Mode - Typed scalar policy for one mapped RDF object.
- Origin
Kind - The kind of a compilation unit. Generic — no
SliceIdhere; thepurrdf-slicelayer interpretsSlice-kind units by wrappingUnitId. - Pack
Error - Why building or opening a pack container failed.
- Page
Fault Kind - The typed reason a provider could not produce a valid page.
- Paged
Freeze Error - Why sealing a provider into a
PagedDatasetfailed. - Paged
Quad Table - Which composed quad stream a
PagedFreezeError::QuadOverlaprefusal came from. The paged view exposes three cross-page streams that each assume disjoint pages and do NO cross-page dedup — the primary quads and the two RDF 1.2 side tables — so the seal enforces disjointness on all three, not just the primary quads. - Paged
Query Error - The typed terminal error of a
PagedQueryView. - Pipeline
Bundle Error - An error from attaching a typed handle to a
PipelineBundle. - Prefix
Postprocessing - Postprocessing applied to one leading-prefix space.
- Projection
Config - Profile-tagged, caller-owned projection configuration.
- Projection
Direction - Portable RDF 1.2 literal base direction.
- Projection
Error Kind - Stable category for a projection failure.
- Projection
Profile - Closed set of RDF projection archive profiles.
- Projection
Term - Dataset-independent, serialization-stable RDF 1.2 term identity.
- Provenance
Error - An error from the provenance gate.
- RdfList
Error - A malformed RDF Collection encountered while walking
rdf:first/rdf:rest. - RdfLookaside
Kind - Known companion/index kinds. Unknown domains remain representable.
- RdfMetadata
Value - A structured metadata value mirroring the CBOR data model, so GTS metadata round-trips without loss.
- RdfSeverity
- Severity for RDF ingestion, conversion, and adapter diagnostics.
- RdfTerm
- Owned RDF 1.2 term.
- RdfTerm
Kind - RDF term category.
- RdfTerm
Target - Canonical RDF 1.2 term identity.
- RdfText
Direction - RDF 1.2 base direction for directional language-tagged literals.
- Relation
Kind - PURREMB v1 structural relation kinds.
- Research
Role - Semantic RDF role understood by the format-neutral research-object pivot.
- Research
Value - Scalar or reference value shared across research-object formats.
- RoCrate
Packaging - Explicit RO-Crate package shape selected by the caller.
- RoCrate
Role - Semantic compact term required by the RO-Crate 1.3 adapter.
- Schema
Compilation Input - Which graph failed canonicalization while deriving a schema cache key.
- Schema
Compile Error - Typed failures from ontology-aware schema compilation.
- Schema
Coverage Precision - Precision of a schema-surface decision.
- Schema
Coverage Status - Stable reason attached to one property/class coverage decision.
- Schema
Surface Mode - Selects the property/class surface projected into developer schemas.
- Serialize
Graph - Which graph(s) a serializer should emit.
- Skolem
Error - Why
skolemize/deskolemizerefused. - Skos
Graph Selection - Source graph selection for one SKOS concept-scheme view.
- Source
Format - A resolved source/target routing identity: a native RDF text syntax, the native pack container, or the GTS transport container.
- Source
Verification Mode - Requested evidence level for an attached source pack.
- Sparql
Result - Materialized SPARQL result model independent of any concrete query engine.
- Sssom
Column Layout Error - A declared SSSOM TSV column-layout construction failure.
- Sssom
Comment Error - A typed set-comment construction failure.
- Sssom
Comment Kind - The lexical kind of a set-scoped SSSOM comment.
- Sssom
Comment Placement - Where a set-scoped SSSOM comment appears in the document envelope.
- Statement
Layer - Which RDF 1.2 statement-layer rows (reifier bindings + annotation triples) the emitted document carries.
- Target
Kind - Stable PURREMB v1 target-kind codes.
- Term
Position - The quad position a refused reserved IRI was found in.
- TermRef
- A borrowed, resolved view of a term — mirrors
InternedTermbut exposes&strslices borrowed from the dataset, so resolving a term performs no allocation and no clone. Triple components are returned as ids; resolve them recursively withRdfDataset::resolveif their values are needed. - Term
Value - A dataset-independent term value — the lookup key for
RdfDataset::term_id_by_value(purrdf P4). - TlvWire
Type - Canonical PURREMB TLV wire types.
- Transport
Encoding - A recognized transport encoding wrapping a payload byte stream.
- Vector
Dtype - Authoritative dense scalar representation.
- View
Operation Status - An atomic checkpoint of an operationally fallible dataset view.
- Void
Graph Selector - Exact source graph selected for one VoID input role.
- Void
Role - Semantic target role in a caller-owned VoID vocabulary.
- Void
Static Value - Caller-authored IRI or RDF literal on the described dataset.
Constants§
- CANON_
CORPUS_ DIGEST - The content-addressed identity of this profile’s normative vector corpus.
- CANON_
PROFILE_ ID - The identifier of the canonicalization profile this module implements.
- CANON_
PROFILE_ VERSION - The version of
CANON_PROFILE_IDthis build implements. - CROISSANT_
ARTIFACT - Sole artifact path in the canonical Croissant package.
- CROISSANT_
PROFILE - Closed Croissant projection profile identifier.
- CROISSANT_
ROLES - Every mandatory Croissant role in deterministic configuration order.
- CSVW_
TERMS_ PROFILE - Stable loss-contract target for the curated terms profile.
- DATACITE_
ARTIFACT - Sole artifact path in the canonical DataCite package.
- DATACITE_
PROFILE - Closed DataCite projection profile identifier.
- DCAT_
ARTIFACT - Sole artifact path in the canonical DCAT package.
- DCAT_
PROFILE - Closed DCAT projection profile identifier.
- DCAT_
ROLES - Every mandatory DCAT role in deterministic configuration order.
- FRICTIONLESS_
ARTIFACT - Sole artifact path in the canonical Frictionless package.
- FRICTIONLESS_
PROFILE - Closed Frictionless Data Package profile identifier.
- GENID_
WELL_ KNOWN_ PATH - The well-known path (RFC 8615) under which skolem IRIs are minted, including
both surrounding separators: a skolem IRI is
{authority}{GENID_WELL_KNOWN_PATH}{encoded}. - GTS_
EXTENSIONS - The extensions/ids that name the GTS transport container, on the same single-authority
rule as
PACK_EXTENSIONS: no other module spells"gts"as a format literal. - JSON_
LD_ SERIALIZE_ OPTIONS_ VERSION - Version of the closed JSON-LD serialization-options document.
- MAX_
TLV_ BLOCK_ LEN - Maximum canonical TLV block size in PURREMB v1.
- MAX_
TLV_ DEPTH - Maximum nested TLV depth in PURREMB v1.
- OKF_
TERMS_ PROFILE - Stable unified-projection profile name for caller-curated OKF bundles.
- PACK_
EXTENSIONS - The extensions/ids that name the native PurRDF pack container. The single authority
for the pack literal — no other module in the workspace may spell
"purrpck"or"pack"as a format literal; every consumer routes throughclassify_source. - PROJECTION_
CODECS - Projection codecs: lossy targets that select a semantic subset of the source graph (decidable fragments, rule languages, foundational profiles).
- PURREMB_
DIRECTORY_ ENTRY_ LENGTH - Fixed PURREMB v1 directory-entry size.
- PURREMB_
FILE_ ALIGNMENT - Required file-relative section alignment.
- PURREMB_
HEADER_ LENGTH - Fixed PURREMB v1 header size.
- PURREMB_
MAGIC - PURREMB v1 file magic.
- PURREMB_
MAX_ SECTION_ COUNT - Maximum number of directory entries in v1.
- PURREMB_
TRAILER_ LENGTH - Fixed PURREMB v1 trailer size.
- PURREMB_
TRAILER_ MAGIC - PURREMB v1 trailer magic.
- PURREMB_
VERSION - PURREMB v1 format version.
- RDFC_
CALL_ LIMIT - The fixed recursion/permutation call budget for the n-degree search. Generous
for every non-adversarial dataset; exhaustion means a pathologically symmetric
blank graph and is a hard
panic!(no knob, no degraded fallback —.goals). - RESEARCH_
OBJECT_ CODECS - Versioned research-object codec names governed by the shared semantic pivot.
- RESEARCH_
ROLES - Every mandatory research-object role, in stable configuration order.
- RESERVED_
NAMESPACE - The IRI namespace the RDF 1.2 overlay lowers into, reserved by this profile.
- RO_
CRATE_ ARTIFACT - Sole artifact path in the canonical RO-Crate package.
- RO_
CRATE_ PREVIEW_ ARTIFACT - Self-contained HTML5 preview path in an attached RO-Crate package.
- RO_
CRATE_ PREVIEW_ FILES_ PREFIX - Reserved prefix for external preview support files.
- RO_
CRATE_ PROFILE - Closed RO-Crate projection profile identifier.
- RO_
CRATE_ ROLES - Every mandatory RO-Crate role in deterministic configuration order.
- SECTION_
CONTRACTS - Vector-family contracts section.
- SECTION_
CRITICAL - Required-section flag.
- SECTION_
DERIVED - Derived-accelerator flag.
- SECTION_
EXTENSION_ MIN - First caller-extension section kind.
- SECTION_
EXTERNAL_ BINDINGS - Exact external-artifact bindings section.
- SECTION_
INDEX_ GUARDS - Opaque derived-index guard section.
- SECTION_
INDEX_ PAYLOAD - Raw inline index-payload section kind.
- SECTION_
MATRICES - Stored-matrix and effective-projection records section.
- SECTION_
MATRIX_ DATA - Raw authoritative matrix-data section kind.
- SECTION_
RELATIONS - Structural target relations section.
- SECTION_
SOURCE - Exact source-pack binding section.
- SECTION_
TARGETS - Canonical target table section.
- SECTION_
TARGET_ SETS - Canonical target-set table section.
- SECTION_
TOKEN_ SPANS - Family-scoped token-span section.
- SSSOM_
DEFAULT_ VALIDATION_ TYPES - The default check set sssom-py runs (
validation_types=None), captured fromsssom.validators.DEFAULT_VALIDATION_TYPESinto the frozen golden. The native validator implements the two reachable-through-parse checks of this set (PrefixMapCompleteness,JsonSchema);StrictCurieFormatis unreachable because PurRDF never emits a pipe-bearing entity slot. Exposed so a consumer can report the parity surface it covers. - VOID_
ROLES - Every mandatory VoID target role, in stable configuration order.
Traits§
- Csvw
RdfTable Mapping - Caller-owned semantics for mapping an RDF backend into a CSVW table group.
- Dataset
Mut - The write companion to
DatasetView— the mutation surface a copy-on-write or backed-by-store dataset exposes (purrdf P5; backend contract C4). - Dataset
View - A static, allocation-free read view over an RDF dataset (purrdf backend contract, C2/C3/C6). All methods are infallible for a frozen, validated dataset.
- Fallible
Dataset View - A
DatasetViewwhose backing data can fail during lazy reads. - LpgProgress
Observer - Fallible observer for deterministic LPG progress snapshots.
- Page
Provider - The demand-paging boundary between a
PagedDatasetand its frozenRdfDatasetpages. - Projection
Artifact Sink - Transactional destination for path-delimited projection artifact chunks.
- RdfDataset
Visitor - A receiver for the evented, ID-addressed output of a frozen
RdfDataset. - RdfParser
Backend - Parser ingress seam: drive RDF bytes into any event sink.
- RdfSerializer
- Serializer egress seam over the frozen IR.
- Sparql
Engine - SPARQL query/update seam. The dataset type is associated so an oxigraph-backed engine can operate on its store while a future native engine can operate on the IR/native query store.
- Term
Factory - Term interning seam: dataset-independent values enter a concrete term table.
Functions§
- assert_
ledger_ complete - Panicking wrapper over
check_ledger_complete: the set of codesledgerrecorded MUST exactly matchexpected_codes. - assert_
ledger_ sound - Panicking wrapper over
check_ledger_sound: every codeledgerrecorded MUST be a member ofprofile_for(from, to). - canonical_
flat_ nquads - The RDFC-1.0 canonical N-Quads document of
dataset, flattened: the RDF 1.2 statement overlay (reifier bindings + annotations) is re-materialized to plainrdf:reifies/ annotation triples BEFORE canonicalizing, with no overlay re-fold. - canonical_
flat_ nquads_ with canonical_flat_nquadswith an explicit RDFC-1.0 hash algorithm (CanonHash::Sha384selects the SHA-384 variant). Used by the W3C RDFC-1.0 conformance gate, whosetest075vector pins SHA-384.- canonical_
relabel - Relabel every blank node of
dsto its canonicalc14n{n}label atBlankScope::DEFAULT, returning a NEW frozen dataset with all other terms, quads, reifiers, annotations, named-graph declarations, and quad source locations preserved. - canonical_
tlv - Validates a canonical TLV block and returns an allocation-free iterator.
- canonicalize
- Canonicalize
dsunder profileCANON_PROFILE_ID(RDFC-1.0 with SHA-256, extended by the RDF 1.2 overlay). - canonicalize_
with - Canonicalize
dsunder profileCANON_PROFILE_IDwith an explicit hash algorithm (CanonHash::Sha384is RDFC-1.0’s SHA-384 variant). Seecanonicalize. - check_
admissible - Whether
dsis admissible to canonicalization under profileCANON_PROFILE_ID— i.e. carries no IRI inRESERVED_NAMESPACE. - check_
ledger_ complete - Verify the set of codes
ledgeractually recorded exactly matchesexpected_codes— “complete” meaning every expected dropped construct is recorded (no silent loss) AND nothing outsideexpected_codesslipped in unnoticed (no undeclared drift). Order and duplicate occurrences inledgerare irrelevant; only the set of distinct codes is compared. - check_
ledger_ sound - Verify every code
ledgeractually recorded is a member ofprofile_for(from, to)— “sound” meaning nothing surprising reached the ledger. A code outside the declared profile is flagged by name: it is an undeclared, unintentional loss (a bug), never an accepted contract. - check_
provenance - Validate the provenance sidecar against the dataset it describes.
- classify
- Resolve a media type or local format id to a
NativeRdfFormat. - classify_
source - Resolve a media type, format id, or (optionally dot-prefixed) file extension to a
SourceFormat. - compile_
schema - Compile an explicit ontology-aware schema request.
- dataset_
diff - A richer diff for test diagnostics: structural counts plus the isomorphism verdict.
- dataset_
from_ bytes - Parse RDF bytes and freeze them into a validated
RdfDatasetvia the native codec path. - dataset_
from_ quad_ sources - Freeze several independently-parsed native
RdfQuadstreams into ONE validatedRdfDataset, folding the RDF 1.2 statement layer, with blank nodes standardized apart per source. - dataset_
from_ quads - Freeze already-built native
RdfQuads into a validatedRdfDataset, folding the RDF 1.2 statement layer. - dataset_
from_ view - Reconstruct a concrete, frozen
Arc<RdfDataset>from ANYDatasetViewby re-interning every term BY VALUE into a freshRdfDatasetBuilder. - datasets_
isomorphic - IR-direct structural comparison. Returns
trueiff the two datasets are RDF-structurally isomorphic: the same quads (under a blank-node bijection), the same reifier bindings, and the same annotations. Oxigraph is NEVER consulted. - decode_
detected - Detect and decode in one step, borrowing
dataunchanged when it is not wrapped. - decode_
transport - Decode
dataunderencoding, draining the decoder to completion. - derive_
artifact_ root - Derives the whole-artifact root from the root-zeroed header and directory.
- derive_
chunking_ contract_ id - Derives the chunking-contract id from the nested chunking-stage block.
- derive_
external_ binding_ id - Derives an external-artifact binding id.
- derive_
external_ contract_ digest - Derives the digest of a canonical external-artifact contract.
- derive_
family_ contract_ digest - Derives a digest from a canonical family-contract block.
- derive_
family_ id - Derives the family id from its contract digest.
- derive_
index_ guard_ digest - Derives the digest of a canonical opaque-index guard.
- derive_
index_ id - Derives an opaque derived-index id.
- derive_
jsonld_ context - Derive a deterministic, vocabulary-neutral JSON-LD context from dataset IRI slots.
- derive_
matrix_ content_ digest - Derives the typed content digest of exact stored matrix bytes.
- derive_
matrix_ id - Derives a stored-matrix id.
- derive_
projection_ content_ digest - Derives the typed content digest of an effective projection byte stream.
- derive_
projection_ id - Derives an effective projection id.
- derive_
relation_ role_ digest - Derives a role digest for an extension relation.
- derive_
target_ id - Derives the target id from its kind and identity digest.
- derive_
target_ identity_ digest - Derives a target identity digest from its kind and canonical block.
- derive_
target_ set_ id - Derives a target-set id from its strictly sorted target ids.
- derive_
vector_ space_ id - Derives one effective vector-space id.
- describe
- One-shot convenience: the SCBD of a single IRI subject in
dataset. - deskolemize
- Deskolemize
datasetunder the caller-suppliedauthority: return a NEW frozen dataset in which exactly the IRIs under{authority}/.well-known/genid/are decoded back to the blank nodes (label,scope) they encode, in every position blanks may occupy. IRIs under any OTHER authority’s genid path are untouched. The exact inverse ofskolemizeunder the same authority. As withskolemize, the non-serialized derived side tables (content_ids,predecessors/predecessor_chain) survive the rewrite (see the crate-privaterebuild_datasethelper). - detect_
transport - Detect the transport encoding wrapping
data. - display_
term - Render an
RdfTermin Turtle term syntax WITHOUT applying the blank-node label escape (full<iri>,_:bnode, literal, or the RDF 1.2 non-asserting triple term<<( <s> <p> <o> )>>). - emit_
annotation - Emit a standalone annotation triple
<reifier> <predicate> <object> .. - emit_
quad - Emit a single quad as a Turtle statement line (
<s> <p> <o> .). - emit_
reifier - Emit a reifier binding as
<reifier> rdf:reifies <<( s p o )>> ; <pred> <obj> ; … . - emit_
resource - Emit a free-standing resource:
<subject> a <type> ; <pred> <obj> ; … . - emit_
term - Serialize an
RdfTermto its Turtle form (full<iri>,_:bnode, literal, or the RDF 1.2 non-asserting triple term<<( <s> <p> <o> )>>). - encode_
external_ bindings - Canonicalizes exact external bindings and encodes
EXTERNAL_BINDINGS. - encode_
family_ contracts - Canonicalizes generation contracts and encodes the
CONTRACTSsection. - encode_
index_ guards - Canonicalizes derived indexes and encodes
INDEX_GUARDSplus inline payload bodies in assigned instance order. - encode_
relations - Canonicalizes structural relations and encodes the
RELATIONSsection. - encode_
target_ sets - Canonicalizes target sets and encodes the
TARGET_SETSsection. - encode_
targets - Canonicalizes targets and encodes the
TARGETSsection. - encode_
token_ spans - Canonicalizes family-scoped spans and encodes the
TOKEN_SPANSsection. - escape_
cypher_ identifier - Escape an openCypher backtick-delimited identifier body.
- escape_
cypher_ string - Escape an openCypher single-quoted string body.
- escape_
xml_ attribute - Escape a double-quoted XML 1.0 attribute value.
- escape_
xml_ text - Escape XML 1.0 character-data text.
- flat_
dataset_ from_ quad_ sources - Freeze several independently-parsed flat owned-
RdfQuadstreams into ONE dataset WITHOUT folding the RDF 1.2 statement layer (every quad — including ardf:reifiestriple-term row — stays a plain quad), with blank nodes standardized apart per source. - flat_
dataset_ from_ quads - Freeze a flat owned-
RdfQuadstream into a dataset WITHOUT folding the RDF 1.2 statement layer (every quad — including ardf:reifiestriple-term row — stays a plain quad). - flat_
rdf_ quads_ from_ dataset - Flatten a frozen
RdfDatasetinto the source-faithful flatRdfQuadstream, for consumers that fold overRdfQuad. Base quads first, then the re-materializedrdf:reifiesreifier rows and the annotation rows. The IR fold + this un-fold are exact inverses. - fno_
to_ ntriples - Serialize a
FnoCatalog’s typed model to N-Triples text (the rdflib-parseable form the Python side re-parses). - fno_
to_ quads - Build the typed model’s quads in the EXACT shape
emit_fno/_emit_fnomproduced — the same triple set, datatypes, and language tags. - gts_
to_ rdf_ loss_ ledger - The intentional losses incurred reading GTS → the RDF 1.2 dataset IR.
- import_
gts_ events - The authoritative GTS ingestion path: folds GTS bytes into a
GtsBundle, preserving per-segment blank-node scope (C2.a). - import_
gts_ graph - Consume a folded GTS
Graphby value, MOVING owned term strings into the interner, and return the frozenGtsBundle. - lift_
archive - Lift one strict bidirectional carrier archive into RDF 1.2.
- lift_
lpg - Lift a validated canonical LPG into a concrete RDF 1.2 dataset.
- lift_
okf_ bundle - Lift a deterministic OKF Markdown bundle into any RDF 1.2 event sink.
- lift_
research_ object - Lift one normalized research-object model into caller-vocabulary RDF 1.2.
- loss_
matrix_ json - The enumerable loss registry as deterministic JSON: every
(from, to)pairregistered_pairsreports — the RDF↔GTS directions, every non-identity syntax/projection transcode pair, the shapes projection, and schema-language emitter profiles — rendered fromregistry_entriessorted by(from, to, code). Unlike a singleLossLedger::contract, codes are NOT assumed unique here — the same code recurs for different(from, to)pairs. - lpg_
to_ rdf_ loss_ ledger - Closed canonical/native LPG→RDF 1.2 interpretation contract.
- okf_
to_ rdf_ loss_ ledger - The closed loss contract for lifting an OKF Markdown bundle into an RDF 1.2 event stream.
- pack_
digest - Read a pack’s stored canonical-identity digest AFTER structural validation, without the
(more expensive) independent recompute
verify_packperforms. - pair_
loss_ ledger - Compute the static loss contract for a
from → totranscoding pair. - parse_
dataset - Parse RDF text bytes of
media_typeinto a frozenRdfDataset. - parse_
dataset_ from_ reader - Parse an RDF document out of a
Readinto a frozenRdfDataset. - parse_
dataset_ with parse_datasetreporting everything the parse learned: the dataset, the opt-in source-position side table, and the base the document ended up under.- profile_
for - The closed set of loss codes a
from -> toconversion may drop, per the enumerable registry. - project_
archive - Project a dataset view into one deterministic USTAR carrier archive.
- project_
archive_ with_ assets - Project RDF 1.2 and a bounded payload carrier into an attached RO-Crate archive.
- project_
construct_ view - Evaluate a caller-supplied SPARQL CONSTRUCT over any static RDF 1.2 dataset view.
- project_
croissant - Project caller-vocabulary RDF 1.2 into canonical Croissant 1.1 JSON.
- project_
csvw - Apply a caller-owned RDF mapping and write its deterministic CSVW package.
- project_
csvw_ exact - Project any RDF dataset view into the canonical exact CSVW profile.
- project_
csvw_ terms - Project any RDF 1.2 dataset backend into caller-declared curated CSVW tables.
- project_
datacite - Project caller-vocabulary RDF 1.2 into deterministic DataCite 4.6 XML.
- project_
dcat - Project caller-vocabulary RDF 1.2 into canonical DCAT 3 JSON-LD.
- project_
dcat_ rdf - Project caller-vocabulary RDF 1.2 into deterministic native DCAT RDF.
- project_
frictionless - Project caller-vocabulary RDF 1.2 into canonical Data Package v1 JSON.
- project_
lpg - Project any static RDF dataset view into the canonical LPG model.
- project_
lpg_ artifacts_ to_ sink - Project one LPG profile directly into a transactional artifact sink.
- project_
lpg_ csv - Project any RDF dataset view directly into the deterministic generic CSV package.
- project_
lpg_ csv_ to_ sink - Project RDF directly into incrementally emitted generic LPG CSV artifacts.
- project_
lpg_ cypher - Project any RDF dataset view directly into the deterministic openCypher package.
- project_
lpg_ cypher_ to_ sink - Project RDF directly into incrementally emitted openCypher artifacts.
- project_
lpg_ graphml - Project any RDF dataset view directly into deterministic GraphML 1.0.
- project_
lpg_ graphml_ to_ sink - Project RDF directly into incrementally emitted GraphML artifacts.
- project_
lpg_ with_ progress - Project an RDF dataset view while reporting monotonic mapping progress.
- project_
neo4j_ csv - Project any RDF dataset view directly into Neo4j Admin Import CSV artifacts.
- project_
neo4j_ csv_ to_ sink - Project RDF directly into incrementally emitted Neo4j Admin Import artifacts.
- project_
obo_ graphs - Project any static RDF dataset backend into OBO Graphs 0.3.2.
- project_
okf_ terms - Project any RDF 1.2 dataset backend into a deterministic caller-curated OKF bundle.
- project_
research_ object - Interpret one RDF 1.2 dataset view as the shared research-object model.
- project_
ro_ crate - Project caller-vocabulary RDF 1.2 into canonical RO-Crate 1.3 JSON-LD.
- project_
ro_ crate_ with_ assets - Project RDF 1.2 plus bounded payload artifacts into an attached RO-Crate 1.3.
- project_
skos - Project any static RDF dataset backend into a deterministic SKOS view.
- project_
void - Generate one deterministic, blank-free VoID dataset description.
- rdf_
gts_ loss_ matrix_ json - The combined RDF↔GTS matrix as a single deterministic, sorted-by-code JSON
array — the body of the generated
generated/rdf-loss-matrix.jsonartifact. - rdf_
to_ gts_ loss_ ledger - The intentional losses incurred projecting the RDF 1.2 dataset IR → GTS.
- rdf_
to_ lpg_ loss_ ledger - Closed RDF 1.2 dataset→canonical LPG semantic-lowering contract.
- rdf_
to_ obo_ graphs_ loss_ ledger - Closed RDF 1.2 dataset→OBO Graphs 0.3.2 view contract.
- rdf_
to_ okf_ loss_ ledger - The closed loss contract for projecting an arbitrary RDF 1.2 dataset to an OKF Markdown bundle.
- rdf_
to_ research_ object_ loss_ ledger - Closed RDF 1.2 dataset→versioned research-object projection contract.
- rdf_
to_ skos_ loss_ ledger - Closed RDF 1.2 dataset→SKOS concept-scheme view contract.
- read_
croissant - Read one strict Croissant 1.1 package and lift it into caller-vocabulary RDF.
- read_
csvw - Parse metadata and tables, validate them, and run the normative RDF mapping.
- read_
csvw_ exact - Decode and strictly validate the canonical exact CSVW profile.
- read_
datacite - Read strict DataCite 4.6 XML and lift caller-vocabulary RDF 1.2.
- read_
dcat - Read strict DCAT 3 JSON-LD and lift caller-vocabulary RDF 1.2.
- read_
frictionless - Read strict Data Package v1 JSON and lift caller-vocabulary RDF 1.2.
- read_
lpg_ csv - Decode the strict generic CSV profile into its canonical LPG model.
- read_
lpg_ cypher - Read the complete closed openCypher grammar emitted by PurRDF.
- read_
lpg_ graphml - Decode the strict GraphML 1.0 profile emitted by PurRDF.
- read_
neo4j_ csv - Decode the strict emitted Neo4j Admin Import profile into canonical LPG.
- read_
ro_ crate - Read a strict RO-Crate 1.3 package and lift caller-vocabulary RDF 1.2.
- registered_
pairs - Every
(from, to)pair with a registered loss profile: the RDF↔GTS directions, graph/tabular/view profiles, every non-identity syntax/projection transcode pair, the shapes projection, and schema-language emitter profiles. - reopen_
prevalidated - Structurally reopens the same immutable resident bytes under a prior proof.
- require_
compatible_ vector_ spaces - Rejects a comparison across distinct effective vector spaces.
- research_
object_ to_ rdf_ loss_ ledger - Closed versioned research-object→RDF 1.2 interpretation contract.
- restore_
pack - Open a succinct dataset pack and restore its complete RDF 1.2 value into a
concrete, frozen
Arc<RdfDataset>. - rule_
iri - Mint the namespaced, percent-encoded rule IRI for a rule label.
- serialize_
dataset - Serialize a frozen
RdfDatasetto RDF text ofmedia_type, honoring theSerializeGraphselection. Returns the serialized bytes. - serialize_
dataset_ to_ format - Serialize the frozen IR to a concrete
NativeRdfFormat, returning the bytes and the count of RDF-1.2 statement-layer rows dropped because the target format does not carry the star layer (the projection doctrine). - serialize_
dataset_ to_ format_ with_ jsonld_ options - Serialize through the generic format surface with explicit JSON-LD/YAML-LD configuration.
- serialize_
dataset_ to_ jsonld - Serialize the carrier dataset to a deterministic JSON-LD-star document.
- serialize_
dataset_ to_ jsonld_ with_ context - Serialize a dataset through an already compiled, reusable caller context.
- serialize_
dataset_ to_ jsonld_ with_ options - Serialize a carrier dataset under an explicitly selected JSON-LD mode.
- serialize_
dataset_ to_ yamlld - Serialize the carrier dataset to deterministic YAML-LD-star bytes.
- serialize_
dataset_ to_ yamlld_ with_ context - Serialize a dataset to deterministic YAML-LD through an already compiled, reusable caller context.
- serialize_
dataset_ to_ yamlld_ with_ options - Serialize a dataset to deterministic YAML-LD under an explicitly selected mode.
- serialize_
dataset_ with - Serialize a frozen dataset under an explicit target format, document base, and policy — the one serialization seam in this crate.
- serialize_
dataset_ with_ jsonld_ options - Serialize JSON-LD or YAML-LD through the generic media-type surface under an explicit configured mode.
- serialize_
rdf_ description - Package an already-materialized RDF 1.2 description graph in any registered syntax.
- skolemize
- Skolemize
datasetunder the caller-suppliedauthority: return a NEW frozen dataset in which every blank node — in subject, object, and graph-name position, inside quoted-triple terms, as a reifier, in annotations, and in named-graph declarations — is replaced by the IRI{authority}/.well-known/genid/{encoded}, per the RDF 1.2 skolemization scheme.encodedis the injective, reversible segment encoding of the blank’s(label, scope)documented at module level, sodeskolemizeunder the same authority reconstructs the original dataset exactly (labels AND scopes). All other terms, quads, reifiers, annotations, and quad source locations are preserved. The non-serialized derived side tables (content_ids,predecessors/predecessor_chain) survive the rewrite too (the crate-privaterebuild_datasethelper implements the exact contract): content addressing re-derives from the output’s IRI bytes underdataset’s ownContentIdScheme, and the predecessor index resolves over the carried-forward annotation table. - sniff_
transport - Detect the transport encoding wrapping a
Readstream WITHOUT consuming it. - stable_
identifier - Build a stable collision-resistant identifier from a caller-owned ASCII prefix and arbitrary key bytes.
- strip_
transport_ suffix - The transport suffix
namecarries, andnamewith that suffix removed. - transcode_
under_ document_ base - Transcode a document from one native syntax to another, re-emitting it under the base the SOURCE document itself declared.
- transport_
reader - Wrap
readerin the decoder forencoding, or pass it through whenencodingisNone. - try_
canonicalize - Canonicalize
dsunder profileCANON_PROFILE_ID, returning a typedCanonErrorinstead of panicking. - try_
canonicalize_ with - Fallible, explicit-hash-algorithm form of
try_canonicalize. Seecanonicalize_withfor the panicking (trusted-caller) equivalent. - validate_
absolute_ iri - Validate a mandatory absolute IRI configuration field.
- verify_
embedding - Verifies every contained digest, identity, scalar, and logical projection.
- verify_
embedding_ source - Verifies the exact attached pack and, optionally, its certified RDF identity.
- verify_
external_ artifact - Checks exact bytes against one generic external-artifact binding.
- verify_
external_ pack - Checks exact bytes and independently certifies a pack-backed external binding.
- verify_
pack - Open, structurally verify, and CERTIFY a pack:
PackView::from_bytesfirst (magic/version/every section’s SHA-256/each submodule’s own structural validation), then independently reconstruct the dataset the pack claims to encode and recompute itspurrdf-rdfc12SHA-256 digest, then compare that recompute to the pack’s own storedrdfc_digestheader field. - write_
csvw - Write a normalized table group to canonical metadata and CSV resources.
- write_
lpg_ csv - Encode a canonical LPG as deterministic generic CSV artifacts.
- write_
lpg_ csv_ to_ sink - Encode generic LPG CSV artifacts incrementally into a transactional sink.
- write_
lpg_ cypher - Encode a canonical LPG as a deterministic, injection-safe openCypher package.
- write_
lpg_ cypher_ to_ sink - Encode canonical LPG artifacts incrementally into a transactional sink.
- write_
lpg_ graphml - Encode a canonical LPG as deterministic GraphML 1.0 XML.
- write_
lpg_ graphml_ to_ sink - Encode canonical GraphML artifacts incrementally into a transactional sink.
- write_
neo4j_ csv - Encode a canonical LPG as deterministic Neo4j Admin Import CSV artifacts.
- write_
neo4j_ csv_ to_ sink - Encode Neo4j Admin Import artifacts incrementally into a transactional sink.
- write_
okf_ bundle - Project a frozen RDF 1.2 dataset through
OkfWriter.
Type Aliases§
- Bytes
- Owned blob payload bytes. A thin alias so the by-reference doctrine reads
clearly at call sites: only the kernel’s
ContentStoreever owns aBytes; everything else holds aContentDigest. - Csvw
Annotations - Common JSON-LD annotations after inherited-property processing.
- Csvw
Natural Language - Natural-language values keyed by a BCP47 language tag.
- Fast
Hasher - The workspace fixed-key
ahashhasher builder. Non-cryptographic, no runtime RNG seeding — see the module docs for the determinism policy. - FastMap
- A
std::collections::HashMapkeyed by the workspaceFastHasher. - FastSet
- A
std::collections::HashSethashed by the workspaceFastHasher. - Handle
Key - The key identifying the named graph a typed handle backs. An IRI string is the stable, dataset-independent name of the graph the handle projects.
- IdSet
- A
FastSetof internedTermIds — the common id-membership set. - IdVec
- A small-vector of interned
TermIds, inline up to 4 ids. - Sniffed
Stream - A stream whose leading magic-byte window has been read and prepended back, so the consumer still sees every byte of the original stream in order.