Trait json_ld_core::loader::Loader

pub trait Loader<I = IriBuf> {
    type Error;

    // Required method
    async fn load_with<V>(
        &mut self,
        vocabulary: &mut V,
        url: I,
    ) -> LoadingResult<I, Self::Error>
       where V: IriVocabularyMut<Iri = I>;

    // Provided method
    async fn load(&mut self, url: I) -> Result<RemoteDocument<I>, Self::Error>
       where (): IriVocabulary<Iri = I> { ... }
}

Document loader.

A document loader is required by most processing functions to fetch remote documents identified by an IRI. In particular, the loader is in charge of fetching all the remote contexts imported in a @context entry.

This library provides a few default loader implementations:

• NoLoader dummy loader that always fail. Perfect if you are certain that the processing will not require any loading.
• Standard HashMap and BTreeMap mapping IRIs to pre-loaded documents. This way no network calls are performed and the loaded content can be trusted.
• FsLoader that redirecting registered IRI prefixes to a local directory on the file system. This also avoids network calls. The loaded content can be trusted as long as the file system is trusted.
• ReqwestLoader actually downloading the remote documents using the reqwest library. This requires the reqwest feature to be enabled.

Required Associated Types

type Error

Error type.

Required Methods

async fn load_with<V>( &mut self, vocabulary: &mut V, url: I, ) -> LoadingResult<I, Self::Error>

where V: IriVocabularyMut<Iri = I>,

Loads the document behind the given IRI, using the given vocabulary.

Provided Methods

async fn load(&mut self, url: I) -> Result<RemoteDocument<I>, Self::Error>

where (): IriVocabulary<Iri = I>,

Loads the document behind the given IRI.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl<'l, I, L: Loader<I>> Loader<I> for &'l mut L

type Error = <L as Loader<I>>::Error

async fn load_with<V>( &mut self, vocabulary: &mut V, url: I, ) -> LoadingResult<I, Self::Error>

where V: IriVocabularyMut<Iri = I>,

async fn load(&mut self, url: I) -> Result<RemoteDocument<I>, Self::Error>

where (): IriVocabulary<Iri = I>,

impl<I: Clone + Eq + Hash> Loader<I> for HashMap<I, RemoteDocument<I>>

type Error = EntryNotFound<I>

async fn load_with<V>( &mut self, _vocabulary: &mut V, url: I, ) -> LoadingResult<I, Self::Error>

where V: IriVocabulary<Iri = I>,

impl<I: Clone + Ord> Loader<I> for BTreeMap<I, RemoteDocument<I>>

type Error = EntryNotFound<I>

async fn load_with<V>( &mut self, _vocabulary: &mut V, url: I, ) -> LoadingResult<I, Self::Error>

where V: IriVocabulary<Iri = I>,

Implementors

impl<I> Loader<I> for FsLoader<I>

type Error = Error

impl<I> Loader<I> for NoLoader

type Error = CannotLoad<I>

impl<I, L1, L2> Loader<I> for ChainLoader<L1, L2>

where I: Clone, L1: Loader<I>, L2: Loader<I>,

type Error = Error<<L1 as Loader<I>>::Error, <L2 as Loader<I>>::Error>