Struct JsonLdDocument 

pub struct JsonLdDocument<T = JsonValue> {
    pub url: Option<IriBuf>,
    pub content_type: Option<Mime>,
    pub context_url: Option<IriBuf>,
    pub profile: HashSet<JsonLdProfile>,
    pub source: Option<JsonLdSourceCode>,
    pub document: T,
}

Remote document.

Stores the content of a loaded remote document along with its original URL.

Fields

url: Option<IriBuf>

The final URL of the loaded document, after eventual redirection.

content_type: Option<Mime>

The HTTP Content-Type header value of the loaded document, exclusive of any optional parameters.

context_url: Option<IriBuf>

If available, the value of the HTTP Link Header RFC 8288 using the http://www.w3.org/ns/json-ld#context link relation in the response.

If the response’s Content-Type is application/ld+json, the HTTP Link Header is ignored. If multiple HTTP Link Headers using the http://www.w3.org/ns/json-ld#context link relation are found, the loader fails with a multiple context link headers error.

profile: HashSet<JsonLdProfile>

source: Option<JsonLdSourceCode>

document: T

The retrieved document.

Implementations

impl JsonLdDocument<JsonLdContextDocumentValue>

pub async fn process( &self, env: impl AsyncJsonLdEnvironment, ) -> Result<JsonLdProcessedContext<'_>, JsonLdLocatedError>

Process this context with the default options.

See: https://www.w3.org/TR/json-ld11-api/#context-processing-algorithm

impl<T> JsonLdDocument<T>

pub fn new(url: Option<IriBuf>, content_type: Option<Mime>, document: T) -> Self

Creates a new remote document.

url is the final URL of the loaded document, after eventual redirection. content_type is the HTTP Content-Type header value of the loaded document, exclusive of any optional parameters.

pub fn new_full( url: Option<IriBuf>, content_type: Option<Mime>, context_url: Option<IriBuf>, profile: HashSet<JsonLdProfile>, source: Option<JsonLdSourceCode>, document: T, ) -> Self

Creates a new remote document.

url is the final URL of the loaded document, after eventual redirection. content_type is the HTTP Content-Type header value of the loaded document, exclusive of any optional parameters. context_url is the value of the HTTP Link Header RFC 8288 using the http://www.w3.org/ns/json-ld#context link relation in the response, if any. profile is the value of any profile parameter retrieved as part of the original contentType.

pub fn map<U>(self, f: impl Fn(T) -> U) -> JsonLdDocument<U>

Maps the content of the remote document.

pub fn try_map<U, E>( self, f: impl Fn(T) -> Result<U, E>, ) -> Result<JsonLdDocument<U>, E>

Tries to map the content of the remote document.

pub fn url(&self) -> Option<&Iri>

Returns a reference to the final URL of the loaded document, after eventual redirection.

pub fn content_type(&self) -> Option<&Mime>

Returns the HTTP Content-Type header value of the loaded document, exclusive of any optional parameters.

pub fn context_url(&self) -> Option<&Iri>

Returns the value of the HTTP Link Header RFC 8288 using the http://www.w3.org/ns/json-ld#context link relation in the response, if any.

If the response’s Content-Type is application/ld+json, the HTTP Link Header is ignored. If multiple HTTP Link Headers using the http://www.w3.org/ns/json-ld#context link relation are found, the loader fails with a multiple context link headers error.

pub fn document(&self) -> &T

Returns a reference to the content of the document.

pub fn document_mut(&mut self) -> &mut T

Returns a mutable reference to the content of the document.

pub fn into_document(self) -> T

Drops the original URL and returns the content of the document.

pub fn into_url(self) -> Option<IriBuf>

Drops the content and returns the original URL of the document.

pub fn set_url(&mut self, url: Option<IriBuf>)

Sets the URL of the document.

impl JsonLdDocument

pub fn try_into_context_document( self, ) -> Result<JsonLdContextDocument, DeserializeError>

Trait Implementations

impl<T: Clone> Clone for JsonLdDocument<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for JsonLdDocument<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl JsonLdExpand for JsonLdDocument

async fn expand( &self, env: impl AsyncJsonLdEnvironment, ) -> Result<JsonLdExpandedDocument, JsonLdLocatedError>

Expand this document with the default expansion options.

async fn expand_with( &self, env: impl AsyncJsonLdEnvironment, active_context: &RawJsonLdProcessedContext, options: JsonLdExpansionOptions, ) -> Result<JsonLdExpandedDocument, JsonLdLocatedError>

Expand this document with the given expansion options and active context.

impl JsonLdProcessor for JsonLdDocument

async fn async_compare_with( &self, other: &Self, env: impl AsyncJsonLdEnvironment, options: JsonLdOptions, ) -> JsonLdCompareResult

Compare this document against other using the given options.

async fn async_expand_with( &self, env: impl AsyncJsonLdEnvironment, options: JsonLdOptions, ) -> JsonLdExpandResult

Expand the document using the given options.

async fn async_compact_with( &self, context: RemoteJsonLdContext, env: impl AsyncJsonLdEnvironment, options: JsonLdOptions, ) -> JsonLdCompactResult

Compact the document relative to context using the given options.

async fn async_flatten_with( &self, context: Option<RemoteJsonLdContext>, env: impl AsyncJsonLdEnvironment, options: JsonLdOptions, ) -> JsonLdFlattenResult

Flatten the document using the given options.

fn compare_with( &self, other: &Self, env: impl JsonLdEnvironment, options: JsonLdOptions, ) -> JsonLdCompareResult

Compare this document against other using the given options.

fn compare( &self, other: &Self, env: impl JsonLdEnvironment, ) -> JsonLdCompareResult

Compare this document against other using default options.

async fn async_compare( &self, other: &Self, env: impl AsyncJsonLdEnvironment, ) -> JsonLdCompareResult

Compare this document against other using default options.

fn expand_with( &self, env: impl JsonLdEnvironment, options: JsonLdOptions, ) -> JsonLdExpandResult

Expand the document using the given options.

fn expand(&self, env: impl JsonLdEnvironment) -> JsonLdExpandResult

Expand the document using default options.

async fn async_expand( &self, env: impl AsyncJsonLdEnvironment, ) -> JsonLdExpandResult

Expand the document using default options.

fn compact_with( &self, context: RemoteJsonLdContext, env: impl JsonLdEnvironment, options: JsonLdOptions, ) -> JsonLdCompactResult

Compact the document relative to context using the given options.

fn compact( &self, context: RemoteJsonLdContext, env: impl JsonLdEnvironment, ) -> JsonLdCompactResult

Compact the document relative to context using default options.

async fn async_compact( &self, context: RemoteJsonLdContext, env: impl AsyncJsonLdEnvironment, ) -> JsonLdCompactResult

Compact the document relative to context using default options.

fn flatten_with( &self, context: Option<RemoteJsonLdContext>, env: impl JsonLdEnvironment, options: JsonLdOptions, ) -> JsonLdFlattenResult

Flatten the document using the given options.

fn flatten( &self, context: Option<RemoteJsonLdContext>, env: impl JsonLdEnvironment, ) -> JsonLdFlattenResult

Flatten the document using default options.

async fn async_flatten( &self, context: Option<RemoteJsonLdContext>, env: impl AsyncJsonLdEnvironment, ) -> JsonLdFlattenResult

Flatten the document using default options.

fn to_rdf_with( &self, env: impl JsonLdEnvironment, generator: impl Generator, options: JsonLdOptions, ) -> JsonLdToRdfResult

Serialize the document to RDF using the given options.

fn to_rdf( &self, env: impl JsonLdEnvironment, generator: impl Generator, ) -> JsonLdToRdfResult

Serialize the document to RDF using default options.

async fn async_to_rdf_with( &self, env: impl AsyncJsonLdEnvironment, generator: impl Generator, options: JsonLdOptions, ) -> JsonLdToRdfResult

Serialize the document to RDF using the given options.

async fn async_to_rdf( &self, env: impl AsyncJsonLdEnvironment, generator: impl Generator, ) -> JsonLdToRdfResult

Serialize the document to RDF using default options.