Crate json_ld

Expand description

This crate is a Rust implementation of the JSON-LD data interchange format.

Linked Data (LD) is a World Wide Web Consortium (W3C) initiative built upon standard Web technologies to create an interrelated network of datasets across the Web. The JavaScript Object Notation (JSON) is a widely used, simple, unstructured data serialization format to describe data objects in a human readable way. JSON-LD brings these two technologies together, adding semantics to JSON to create a lightweight data serialization format that can organize data and help Web applications to inter-operate at a large scale.

§Usage

The entry point for this library is the JsonLdProcessor trait that provides an access to all the JSON-LD transformation algorithms (context processing, expansion, compaction, etc.). If you want to explore and/or transform ExpandedDocuments, you may also want to check out the Object type representing a JSON object.

§Expansion

If you want to expand a JSON-LD document, first describe the document to be expanded using either RemoteDocument or RemoteDocumentReference:

RemoteDocument wraps the JSON representation of the document alongside its remote URL.
RemoteDocumentReference may represent only an URL, letting some loader fetching the remote document by dereferencing the URL.

After that, you can simply use the JsonLdProcessor::expand function on the remote document.

§Example

use iref::IriBuf;
use static_iref::iri;
use json_ld::{JsonLdProcessor, Options, RemoteDocument, syntax::{Value, Parse}};

// Create a "remote" document by parsing a file manually.
let input = RemoteDocument::new(
  // We use `IriBuf` as IRI type.
  Some(iri!("https://example.com/sample.jsonld").to_owned()),

  // Optional content type.
  Some("application/ld+json".parse().unwrap()),
   
  // Parse the file.
  Value::parse_str(r#"
    {
      "@context": {
        "name": "http://xmlns.com/foaf/0.1/name"
      },
      "@id": "https://www.rust-lang.org",
      "name": "Rust Programming Language"
    }"#).expect("unable to parse file").0
);

// Use `NoLoader` as we won't need to load any remote document.
let mut loader = json_ld::NoLoader;

// Expand the "remote" document.
let expanded = input
  .expand(&mut loader)
  .await
  .expect("expansion failed");

for object in expanded {
  if let Some(id) = object.id() {
    let name = object.as_node().unwrap()
      .get_any(&iri!("http://xmlns.com/foaf/0.1/name")).unwrap()
      .as_str().unwrap();

    println!("id: {id}");
    println!("name: {name}");
  }
}

Here is another example using RemoteDocumentReference.

use static_iref::iri;
use json_ld::{JsonLdProcessor, Options, RemoteDocumentReference};

let input = RemoteDocumentReference::iri(iri!("https://example.com/sample.jsonld").to_owned());

// Use `FsLoader` to redirect any URL starting with `https://example.com/` to
// the local `example` directory. No HTTP query.
let mut loader = json_ld::FsLoader::default();
loader.mount(iri!("https://example.com/").to_owned(), "examples");

let expanded = input.expand(&mut loader)
  .await
  .expect("expansion failed");

Lastly, the same example replacing IriBuf with the lightweight rdf_types::vocabulary::Index type.

use rdf_types::{Subject, vocabulary::{IriVocabularyMut, IndexVocabulary}};
use contextual::WithContext;
// Creates the vocabulary that will map each `rdf_types::vocabulary::Index`
// to an actual `IriBuf`.
let mut vocabulary: IndexVocabulary = IndexVocabulary::new();

let iri_index = vocabulary.insert(iri!("https://example.com/sample.jsonld"));
let input = RemoteDocumentReference::iri(iri_index);

// Use `FsLoader` to redirect any URL starting with `https://example.com/` to
// the local `example` directory. No HTTP query.
let mut loader = json_ld::FsLoader::default();
loader.mount(iri!("https://example.com/").to_owned(), "examples");

let expanded = input
  .expand_with(&mut vocabulary, &mut loader)
  .await
  .expect("expansion failed");

// `foaf:name` property identifier.
let name_id = Subject::Iri(vocabulary.insert(iri!("http://xmlns.com/foaf/0.1/name")));

for object in expanded {
  if let Some(id) = object.id() {
    let name = object.as_node().unwrap()
      .get_any(&name_id).unwrap()
      .as_value().unwrap()
      .as_str().unwrap();

    println!("id: {}", id.with(&vocabulary));
    println!("name: {name}");
  }
}

§Compaction

The JSON-LD Compaction is a transformation that consists in applying a context to a given JSON-LD document reducing its size. There are two ways to get a compact JSON-LD document with this library depending on your starting point:

If you want to get a compact representation for an arbitrary remote document, simply use the JsonLdProcessor::compact (or JsonLdProcessor::compact_with) method.
Otherwise to compact an ExpandedDocument you can use the Compact::compact method.

§Example

Here is an example compaction an arbitrary RemoteDocumentReference using JsonLdProcessor::compact.

use static_iref::iri;
use json_ld::{JsonLdProcessor, Options, RemoteDocumentReference, RemoteContextReference, syntax::Print};

let input = RemoteDocumentReference::iri(iri!("https://example.com/sample.jsonld").to_owned());

let context = RemoteContextReference::iri(iri!("https://example.com/context.jsonld").to_owned());

// Use `FsLoader` to redirect any URL starting with `https://example.com/` to
// the local `example` directory. No HTTP query.
let mut loader = json_ld::FsLoader::default();
loader.mount(iri!("https://example.com/").to_owned(), "examples");

let compact = input
  .compact(context, &mut loader)
  .await
  .expect("compaction failed");

println!("output: {}", compact.pretty_print());

§Flattening

The JSON-LD Flattening is a transformation that consists in moving nested nodes out. The result is a list of all the nodes declared in the document. There are two ways to flatten JSON-LD document with this library depending on your starting point:

If you want to get a compact representation for an arbitrary remote document, simply use the JsonLdProcessor::flatten (or JsonLdProcessor::flatten_with) method. This will return a JSON-LD document.
Otherwise to compact an ExpandedDocument you can use the Flatten::flatten (or Flatten::flatten_with) method. This will return the list of nodes as a FlattenedDocument.

Flattening requires assigning an identifier to nested anonymous nodes, which is why the flattening functions take an rdf_types::MetaGenerator as parameter. This generator is in charge of creating new fresh identifiers (with their metadata). The most common generator is rdf_types::generator::Blank that creates blank node identifiers.

§Example

Here is an example compaction an arbitrary RemoteDocumentReference using JsonLdProcessor::flatten.

use static_iref::iri;
use json_ld::{JsonLdProcessor, Options, RemoteDocumentReference, syntax::Print};

let input = RemoteDocumentReference::iri(iri!("https://example.com/sample.jsonld").to_owned());

// Use `FsLoader` to redirect any URL starting with `https://example.com/` to
// the local `example` directory. No HTTP query.
let mut loader = json_ld::FsLoader::default();
loader.mount(iri!("https://example.com/").to_owned(), "examples");

let mut generator = rdf_types::generator::Blank::new();

let nodes = input
  .flatten(&mut generator, &mut loader)
  .await
  .expect("flattening failed");

println!("output: {}", nodes.pretty_print());

§Fast IRIs and Blank Node Identifiers

This library gives you the opportunity to use any datatype you want to represent IRIs an Blank Node Identifiers. Most types have them parameterized. To avoid unnecessary allocations and expensive comparisons, it is highly recommended to use a cheap, lightweight datatype such as rdf_types::vocabulary::Index. This type will represent each distinct IRI/blank node identifier with a unique index. In this case a rdf_types::IndexVocabulary that maps each index back/to its original IRI/Blank identifier representation can be passed to every function.

You can also use your own index type, with your own rdf_types::Vocabulary implementation.

§Displaying vocabulary-dependent values

Since using vocabularies separates IRIs and Blank ids from their textual representation, it complicates displaying data using them. Fortunately many types defined by json-ld implement the contextual::DisplayWithContext trait that allow displaying value with a “context”, which here would be the vocabulary. By importing the contextual::WithContext which provides the with method you can display such value like this:

use static_iref::iri;
use rdf_types::vocabulary::{IriVocabularyMut, IndexVocabulary};
use contextual::WithContext;

let mut vocabulary: IndexVocabulary = IndexVocabulary::new();
let i = vocabulary.insert(iri!("https://docs.rs/contextual"));
let value = rdf_types::Subject::Iri(i);

println!("{}", value.with(&vocabulary))

Re-exports§

pub use json_ld_compaction as compaction;
pub use json_ld_context_processing as context_processing;
pub use json_ld_expansion as expansion;
pub use json_ld_serialization as ser;
pub use json_ld_syntax as syntax;
pub use rdf_types;

Modules§

context: Context processing algorithm and related types.
expanded
flattened
flattening: Flattening algorithm and related types.
id
loader
object: Nodes, lists and values.
print
quad
rdf
utils: Utility functions.
warning

Structs§

BlankId: Blank node identifier.
BlankIdBuf: Owned blank node identifier.
ChainLoader: ChainLoader: loads document from the first loader, otherwise falls back to the second one.
Context: Processed JSON-LD context.
Document: JSON-LD document in both compact and expanded form.
Environment
ExpandedDocument: Result of the document expansion algorithm.
FsLoader: File-system loader.
Indexed: Indexed objects.
InvalidIri
InvalidLangString: Raised when something tried to build a language string without language tag or direction.
Iri: Internationalized Resource Identifier (IRI).
IriBuf: Owned IRI.
IriRef: IRI reference.
IriRefBuf: Owned IRI reference.
LangStr: Language string reference.
LangString: Language string.
LenientLangTag: Language tag that may not be well-formed.
LenientLangTagBuf: Owned language tag that may not be well-formed.
LoadError: Loading error.
NoLoader: Dummy loader.
Node: Node object.
Nodes: Iterator through indexed nodes.
Objects: Iterator through indexed objects.
Options: JSON-LD Processor options.
RemoteDocument: Remote document.
ReqwestLoader: reqwest-based loader.
ToRdf

Enums§

CompactError: Error that can be raised by the JsonLdProcessor::compact function.
Container
ContainerKind
ContextLoadError
Direction: Internationalized string direction.
ExpandError: Error that can be raised by the JsonLdProcessor::expand function.
ExtractContextError: Context extraction error.
FlattenError: Error that can be raised by the JsonLdProcessor::flatten function.
Id: Node identifier.
Nullable: Value that can be null.
Object: Object.
ProcessingMode: Processing mode.
Profile: Value for the profile parameter defined for the application/ld+json.
Ref: Id to a reference.
RemoteDocumentReference: Remote document, loaded or not.
StandardProfile: Standard profile parameter values defined for the application/ld+json.
Term: Identifier, keyword or @null.
ToRdfError: Error that can be raised by the JsonLdProcessor::to_rdf function.
Type: Object type.
ValidId: RDF node identifier.
Value: Value object.

Traits§

Compact: Compaction function.
Expand: Document expansion.
ExtractContext
Flatten
IdentifyAll
JsonLdProcessor: Application Programming Interface.
LdQuads
Loader: Document loader.
Print: Print methods.
Process
RdfQuads
Relabel
TryFromJson: Try to convert from a JSON value directly into an expanded JSON-LD document without going through the expansion algorithm.

Type Aliases§

CompactResult: Result of the JsonLdProcessor::compact function.
CompareResult: Result of the JsonLdProcessor::compare function.
ExpandResult: Result returned by the JsonLdProcessor::expand function.
FlattenResult: Result of the JsonLdProcessor::flatten function.
FlattenedDocument: Result of the document flattening algorithm.
IndexedNode
IndexedObject: Indexed object.
IntoDocumentResult: Result returned by the JsonLdProcessor::into_document function.
LoadErrorCause
LoadingResult
RemoteContext
RemoteContextReference
ToRdfResult: Error that can be raised by the JsonLdProcessor::to_rdf function.
ValidVocabularyId
VocabularyId

Crate json_ldCopy item path

§Usage

§Expansion

§Example

§Compaction

§Example

§Flattening

§Example

§Fast IRIs and Blank Node Identifiers

§Displaying vocabulary-dependent values

Re-exports§

Modules§

Structs§

Enums§

Traits§

Type Aliases§

Crate json_ld