Crate ssi_json_ld

Source
Expand description

Linked-Data types.

Re-exports§

pub use json_ld;

Modules§

compaction
This library implements the JSON-LD compaction algorithm for the json-ld crate.
context
Context processing algorithm and related types.
context_processing
JSON-LD context processing types and algorithms.
expanded
expansion
This library implements the JSON-LD expansion algorithm for the json-ld crate.
flattened
flattening
Flattening algorithm and related types.
id
iref
This crates provides an implementation of Uniform Resource Identifiers (URIs, aka URLs) and Internationalized Resource Identifiers (IRIs) following RFC 3987 and RFC 3986 defined by the Internet Engineering Task Force (IETF) to uniquely identify objects across the web. IRIs are a superclass of URIs accepting international characters defined in the Unicode table.
loader
object
Nodes, lists and values.
print
quad
rdf
rdf_types
The Resource Description Framework (RDF) is a very simple graph data model defined by the World Wide Web Consortium (W3C) to represent arbitrary pieces of information, primarily intended for the web. Nodes of the graph are called resources, and resources are connected together using relations, which are resources themselves.
ser
This crate implements JSON-LD serialization (from RDF dataset to JSON-LD) through the linked_data crate. The input value can be an RDF dataset, or any type implementing linked_data::LinkedData.
syntax
This library provide functions to parse JSON-LD contexts and print JSON-LD documents.
utils
Utility functions.

Structs§

BBS_V1_CONTEXT_DOCUMENT
BLOCKCHAIN2021_V1_CONTEXT_DOCUMENT
BlankId
Blank node identifier.
BlankIdBuf
Owned blank node identifier.
CACAO_ZCAP_V1_CONTEXT_DOCUMENT
CITIZENSHIP_V1_CONTEXT_DOCUMENT
CREDENTIALS_EXAMPLES_V1_CONTEXT_DOCUMENT
CREDENTIALS_EXAMPLES_V2_CONTEXT_DOCUMENT
CREDENTIALS_V1_CONTEXT_DOCUMENT
CREDENTIALS_V2_CONTEXT_DOCUMENT
ChainLoader
ChainLoader: loads document from the first loader, otherwise falls back to the second one.
CompactJsonLd
Context
Processed JSON-LD context.
ContextLoader
DID_CONFIGURATION_V0_0_CONTEXT_DOCUMENT
DID_CONFIGURATION_V1_CONTEXT_DOCUMENT
DID_RESOLUTION_V1_CONTEXT_DOCUMENT
DID_V1_CONTEXT_DOCUMENT
DIF_ESRS2020_CONTEXT_DOCUMENT
Deprecated in favor of W3ID_ESRS2020_V2_CONTEXT_DOCUMENT
Document
JSON-LD document in both compact and expanded form.
EIP712SIG_V0_1_CONTEXT_DOCUMENT
EIP712SIG_V1_CONTEXT_DOCUMENT
ESRS2020_EXTRA_CONTEXT_DOCUMENT
Deprecated in favor of W3ID_ESRS2020_V2_CONTEXT_DOCUMENT
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.
JFF_VC_EDU_PLUGFEST_2022_2_CONTEXT_DOCUMENT
JFF_VC_EDU_PLUGFEST_2022_CONTEXT_DOCUMENT
JsonLdTypes
LDS_JWS2020_V1_CONTEXT_DOCUMENT
LINKED_VP_V1_CONTEXT_DOCUMENT
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.
ODRL_CONTEXT_DOCUMENT
Objects
Iterator through indexed objects.
Options
JSON-LD Processor options.
PRESENTATION_SUBMISSION_V1_CONTEXT_DOCUMENT
REVOCATION_LIST_2020_V1_CONTEXT_DOCUMENT
RemoteDocument
Remote document.
SCHEMA_ORG_CONTEXT_DOCUMENT
SECURITY_V1_CONTEXT_DOCUMENT
SECURITY_V2_CONTEXT_DOCUMENT
STATUS_LIST_2021_V1_CONTEXT_DOCUMENT
StaticLoader
TRACEABILITY_CONTEXT_DOCUMENT
ToRdf
UnknownContext
Error raised when an unknown context is loaded with StaticLoader or ContextLoader.
VACCINATION_V1_CONTEXT_DOCUMENT
VDL_V1_CONTEXT_DOCUMENT
W3ID_DATA_INTEGRITY_V1_CONTEXT_DOCUMENT
W3ID_DATA_INTEGRITY_V2_CONTEXT_DOCUMENT
W3ID_ED2020_V1_CONTEXT_DOCUMENT
W3ID_ESRS2020_V2_CONTEXT_DOCUMENT
W3ID_JWS2020_V1_CONTEXT_DOCUMENT
W3ID_MULTIKEY_V1_CONTEXT_DOCUMENT
WALLET_V1_CONTEXT_DOCUMENT
WithContext
ZCAP_V1_CONTEXT_DOCUMENT

Enums§

CompactError
Error that can be raised by the JsonLdProcessor::compact function.
Container
ContainerKind
ContextError
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.
FromContextMapError
Error that can be raised by the ContextLoader::with_context_map_from constructor function.
Id
Node identifier.
JsonLdError
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.

Constants§

BBS_V1_CONTEXT
BLOCKCHAIN2021_V1_CONTEXT
CACAO_ZCAP_V1_CONTEXT
CITIZENSHIP_V1_CONTEXT
CREDENTIALS_EXAMPLES_V1_CONTEXT
CREDENTIALS_EXAMPLES_V2_CONTEXT
CREDENTIALS_V1_CONTEXT
CREDENTIALS_V2_CONTEXT
DID_CONFIGURATION_V0_0_CONTEXT
DID_CONFIGURATION_V1_CONTEXT
DID_RESOLUTION_V1_CONTEXT
DID_V1_CONTEXT
DID_V1_CONTEXT_NO_WWW
DIF_ESRS2020_CONTEXT
EIP712SIG_V0_1_CONTEXT
EIP712SIG_V1_CONTEXT
ESRS2020_EXTRA_CONTEXTDeprecated
JFF_VC_EDU_PLUGFEST_2022_2_CONTEXT
JFF_VC_EDU_PLUGFEST_2022_CONTEXT
LDS_JWS2020_V1_CONTEXT
LINKED_VP_V1_CONTEXT
ODRL_CONTEXT
PRESENTATION_SUBMISSION_V1_CONTEXT
REVOCATION_LIST_2020_V1_CONTEXT
SCHEMA_ORG_CONTEXT
SECURITY_V1_CONTEXT
SECURITY_V2_CONTEXT
STATUS_LIST_2021_V1_CONTEXT
TRACEABILITY_CONTEXT
VACCINATION_V1_CONTEXT
VDL_V1_CONTEXT
W3ID_DATA_INTEGRITY_V1_CONTEXT
W3ID_DATA_INTEGRITY_V2_CONTEXT
W3ID_DID_V1_CONTEXT
W3ID_ED2020_V1_CONTEXT
W3ID_ESRS2020_V2_CONTEXT
W3ID_JWS2020_V1_CONTEXT
W3ID_MULTIKEY_V1_CONTEXT
WALLET_V1_CONTEXT
ZCAP_V1_CONTEXT

Traits§

Compact
Compaction function.
Expand
Document expansion.
Expandable
JSON-LD-Expandable value.
ExtractContext
Flatten
IdentifyAll
JsonLdLoaderProvider
Type that provides a JSON-LD document loader.
JsonLdNodeObject
JsonLdObject
Any type representing a JSON-LD object.
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.

Functions§

parse_ld_context
Parse a JSON-LD context.

Type Aliases§

CompactResult
Result of the JsonLdProcessor::compact function.
CompareResult
Result of the JsonLdProcessor::compare function.
ContextMap
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