Enum RemoteDocumentReference 

pub enum RemoteDocumentReference<I = IriBuf, T = Value> {
    Iri(I),
    Loaded(RemoteDocument<I, T>),
}

Remote document, loaded or not.

Either an IRI or the actual document content.

Variants

Iri(I)

IRI to the remote document.

Loaded(RemoteDocument<I, T>)

Remote document content.

Implementations

impl<I, T> RemoteDocumentReference<I, T>

pub fn iri(iri: I) -> RemoteDocumentReference<I, T>

Creates an IRI to a json_syntax::Value JSON document.

This method can replace RemoteDocumentReference::Iri to help the type inference in the case where T = json_syntax::Value.

impl<I> RemoteDocumentReference<I>

pub async fn load_with<V>( self, vocabulary: &mut V, loader: &impl Loader, ) -> Result<RemoteDocument<I>, LoadError>

where V: IriVocabularyMut<Iri = I>, I: Clone + Eq + Hash,

Loads the remote document with the given vocabulary and loader.

If the document is already Self::Loaded, simply returns the inner RemoteDocument.

pub async fn loaded_with<V>( &self, vocabulary: &mut V, loader: &impl Loader, ) -> Result<Cow<'_, RemoteDocument<<V as IriVocabulary>::Iri>>, LoadError>

where V: IriVocabularyMut<Iri = I>, I: Clone + Eq + Hash,

Loads the remote document with the given vocabulary and loader.

For Self::Iri returns an owned RemoteDocument with Cow::Owned. For Self::Loaded returns a reference to the inner RemoteDocument with Cow::Borrowed.

impl<I> RemoteDocumentReference<I, Context>

pub async fn load_context_with<V, L>( self, vocabulary: &mut V, loader: &L, ) -> Result<RemoteDocument<I, Context>, ContextLoadError>

where L: Loader, V: IriVocabularyMut<Iri = I>, I: Clone + Eq + Hash,

Loads the remote context with the given vocabulary and loader.

If the context is already Self::Loaded, simply returns the inner RemoteContext.

pub async fn loaded_context_with<V, L>( &self, vocabulary: &mut V, loader: &L, ) -> Result<Cow<'_, RemoteDocument<I, Context>>, ContextLoadError>

where L: Loader, V: IriVocabularyMut<Iri = I>, I: Clone + Eq + Hash,

Loads the remote context with the given vocabulary and loader.

For Self::Iri returns an owned RemoteContext with Cow::Owned. For Self::Loaded returns a reference to the inner RemoteContext with Cow::Borrowed.

Trait Implementations

impl<I, T> Clone for RemoteDocumentReference<I, T>

where I: Clone, T: Clone,

fn clone(&self) -> RemoteDocumentReference<I, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I> JsonLdProcessor<I> for RemoteDocumentReference<I>

async fn compare_full<N>( &self, other: &RemoteDocumentReference<I>, vocabulary: &mut N, loader: &impl Loader, options: Options<I>, warnings: impl WarningHandler<N> + WarningHandler<N>, ) -> Result<bool, ExpandError>

where N: VocabularyMut<Iri = I>, I: Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: Clone + Eq + Hash,

Compare this document against other with a custom vocabulary using the given options and warnings handler.

async fn expand_full<N>( &self, vocabulary: &mut N, loader: &impl Loader, options: Options<I>, warnings: impl WarningHandler<N> + WarningHandler<N>, ) -> Result<ExpandedDocument<I, <N as BlankIdVocabulary>::BlankId>, ExpandError>

where N: VocabularyMut<Iri = I>, I: Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: Clone + Eq + Hash,

Expand the document with the given vocabulary and loader, using the given options and warning handler.

async fn into_document_full<'a, N>( self, vocabulary: &'a mut N, loader: &'a impl Loader, options: Options<I>, warnings: impl WarningHandler<N> + WarningHandler<N> + 'a, ) -> Result<Document<I, <N as BlankIdVocabulary>::BlankId>, ExpandError>

where N: VocabularyMut<Iri = I>, I: 'a + Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: 'a + Clone + Eq + Hash,

async fn compact_full<'a, N>( &'a self, vocabulary: &'a mut N, context: RemoteDocumentReference<I, Context>, loader: &'a impl Loader, options: Options<I>, warnings: impl WarningHandler<N> + WarningHandler<N> + 'a, ) -> Result<Value, CompactError>

where N: VocabularyMut<Iri = I>, I: Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: 'a + Clone + Eq + Hash,

Compact the document relative to context with the given vocabulary and loader, using the given options and warning handler.

async fn flatten_full<'a, N>( &'a self, vocabulary: &'a mut N, generator: &'a mut impl Generator<N>, context: Option<RemoteDocumentReference<I, Context>>, loader: &'a impl Loader, options: Options<I>, warnings: impl WarningHandler<N> + WarningHandler<N> + 'a, ) -> Result<Value, FlattenError<I, <N as BlankIdVocabulary>::BlankId>>

where N: VocabularyMut<Iri = I>, I: Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: 'a + Clone + Eq + Hash,

Flatten the document with the given vocabulary, generator and loader, using the given options and warning handler.

async fn compare_with_using<'a, N>( &'a self, other: &'a Self, vocabulary: &'a mut N, loader: &'a impl Loader, options: Options<Iri>, ) -> Result<bool, ExpandError>

where N: VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: 'a + Clone + Eq + Hash,

Compare this document against other with a custom vocabulary using the given options.

async fn compare_with<'a, N>( &'a self, other: &'a Self, vocabulary: &'a mut N, loader: &'a impl Loader, ) -> Result<bool, ExpandError>

where N: VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: 'a + Clone + Eq + Hash,

Compare this document against other with a custom vocabulary.

async fn compare_using<'a>( &'a self, other: &'a Self, loader: &'a impl Loader, options: Options<Iri>, ) -> Result<bool, ExpandError>

where (): VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash,

Compare this document against other using the given options.

async fn compare<'a>( &'a self, other: &'a Self, loader: &'a impl Loader, ) -> Result<bool, ExpandError>

where (): VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash,

Compare this document against other with a custom vocabulary.

async fn expand_with_using<'a, N>( &'a self, vocabulary: &'a mut N, loader: &'a impl Loader, options: Options<Iri>, ) -> Result<ExpandedDocument<Iri, <N as BlankIdVocabulary>::BlankId>, ExpandError>

where N: VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: 'a + Clone + Eq + Hash,

Expand the document with the given vocabulary and loader, using the given options.

async fn expand_with<'a, N>( &'a self, vocabulary: &'a mut N, loader: &'a impl Loader, ) -> Result<ExpandedDocument<Iri, <N as BlankIdVocabulary>::BlankId>, ExpandError>

where N: VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: 'a + Clone + Eq + Hash,

Expand the document with the given vocabulary and loader.

async fn expand_using<'a>( &'a self, loader: &'a impl Loader, options: Options<Iri>, ) -> Result<ExpandedDocument<Iri>, ExpandError>

where (): VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash,

Expand the document with the given loader using the given options.

async fn expand<'a>( &'a self, loader: &'a impl Loader, ) -> Result<ExpandedDocument<Iri>, ExpandError>

where (): VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash,

Expand the document with the given loader.

async fn into_document_with_using<'a, N>( self, vocabulary: &'a mut N, loader: &'a impl Loader, options: Options<Iri>, ) -> Result<Document<Iri, <N as BlankIdVocabulary>::BlankId>, ExpandError>

where N: VocabularyMut<Iri = Iri>, Iri: 'a + Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: 'a + Clone + Eq + Hash,

async fn into_document_with<'a, N>( self, vocabulary: &'a mut N, loader: &'a impl Loader, ) -> Result<Document<Iri, <N as BlankIdVocabulary>::BlankId>, ExpandError>

where N: VocabularyMut<Iri = Iri>, Iri: 'a + Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: 'a + Clone + Eq + Hash,

async fn into_document<'a>( self, loader: &'a impl Loader, ) -> Result<Document<Iri>, ExpandError>

where (): VocabularyMut<Iri = Iri>, Iri: 'a + Clone + Eq + Hash,

async fn compact_with_using<'a, N>( &'a self, vocabulary: &'a mut N, context: RemoteDocumentReference<Iri, Context>, loader: &'a impl Loader, options: Options<Iri>, ) -> Result<Value, CompactError>

where N: VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: 'a + Clone + Eq + Hash,

Compact the document relative to context with the given vocabulary and loader, using the given options.

async fn compact_with<'a, N>( &'a self, vocabulary: &'a mut N, context: RemoteDocumentReference<Iri, Context>, loader: &'a impl Loader, ) -> Result<Value, CompactError>

where N: VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: 'a + Clone + Eq + Hash,

Compact the document relative to context with the given vocabulary and loader.

async fn compact_using<'a>( &'a self, context: RemoteDocumentReference<Iri, Context>, loader: &'a impl Loader, options: Options<Iri>, ) -> Result<Value, CompactError>

where (): VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash,

Compact the document relative to context with the given loader, using the given options.

async fn compact<'a>( &'a self, context: RemoteDocumentReference<Iri, Context>, loader: &'a impl Loader, ) -> Result<Value, CompactError>

where (): VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash,

Compact the document relative to context with the given loader.

async fn flatten_with_using<'a, N>( &'a self, vocabulary: &'a mut N, generator: &'a mut impl Generator<N>, loader: &'a impl Loader, options: Options<Iri>, ) -> Result<Value, FlattenError<Iri, <N as BlankIdVocabulary>::BlankId>>

where N: VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: 'a + Clone + Eq + Hash,

Flatten the document with the given vocabulary, generator and loader, using the given options.

async fn flatten_with<'a, N>( &'a self, vocabulary: &'a mut N, generator: &'a mut impl Generator<N>, loader: &'a impl Loader, ) -> Result<Value, FlattenError<Iri, <N as BlankIdVocabulary>::BlankId>>

where N: VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: 'a + Clone + Eq + Hash,

Flatten the document with the given vocabulary, generator and loader.

async fn flatten_using<'a>( &'a self, generator: &'a mut impl Generator, loader: &'a impl Loader, options: Options<Iri>, ) -> Result<Value, FlattenError<Iri, BlankIdBuf>>

where (): VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash,

Flatten the document with the given generator, loader and using the given options.

async fn flatten<'a>( &'a self, generator: &'a mut impl Generator, loader: &'a impl Loader, ) -> Result<Value, FlattenError<Iri, BlankIdBuf>>

where (): VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash,

Flatten the document with the given generator and loader.

async fn to_rdf_full<N, G>( &self, vocabulary: N, generator: G, loader: &impl Loader, options: Options<Iri>, warnings: impl WarningHandler<N> + WarningHandler<N>, ) -> Result<ToRdf<N, G>, ToRdfError>

where N: VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: Clone + Eq + Hash, G: Generator<N>,

Serializes the document into an RDF dataset with a custom vocabulary using the given options and warnings handler.

async fn to_rdf_with_using<N, G>( &self, vocabulary: N, generator: G, loader: &impl Loader, options: Options<Iri>, ) -> Result<ToRdf<N, G>, ToRdfError>

where N: VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: Clone + Eq + Hash, G: Generator<N>,

Serializes the document into an RDF dataset with a custom vocabulary using the given options.

async fn to_rdf_with<N, G>( &self, vocabulary: N, generator: G, loader: &impl Loader, ) -> Result<ToRdf<N, G>, ToRdfError>

where N: VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash, <N as BlankIdVocabulary>::BlankId: Clone + Eq + Hash, G: Generator<N>,

Serializes the document into an RDF dataset with a custom vocabulary.

async fn to_rdf_using<G>( &self, generator: G, loader: &impl Loader, options: Options<Iri>, ) -> Result<ToRdf<(), G>, ToRdfError>

where (): VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash, G: Generator,

Serializes the document into an RDF dataset using the given options.

async fn to_rdf<G>( &self, generator: G, loader: &impl Loader, ) -> Result<ToRdf<(), G>, ToRdfError>

where (): VocabularyMut<Iri = Iri>, Iri: Clone + Eq + Hash, G: Generator,

Serializes the document into an RDF dataset.