Struct json_ld::FsLoader

pub struct FsLoader<I = Index, M = Location<I, Span>, T = Value<M>, E = Meta<Error<M, Infallible>, M>> { /* private fields */ }

File-system loader.

This is a special JSON-LD document loader that can load document from the file system by attaching a directory to specific URLs.

Loaded documents are not cached: a new file system read is made each time an URL is loaded even if it has already been queried before.

Implementations

impl<I, M, T, E> FsLoader<I, M, T, E>

pub fn mount<P>(&mut self, url: I, path: P)where
    P: AsRef<Path>,

Bind the given IRI prefix to the given path.

Any document with an IRI matching the given prefix will be loaded from the referenced local directory.

pub fn filepath(
    &self,
    vocabulary: &impl IriVocabulary<Iri = I>,
    url: &I
) -> Option<PathBuf>

Returns the local file path associated to the given url if any.

impl<I, M, T, E> FsLoader<I, M, T, E>

pub fn new(
    parser: impl Send + Sync + FnMut(&dyn IriVocabulary<Iri = I>, &I, &str) -> Result<Meta<T, M>, E> + 'static
) -> FsLoader<I, M, T, E>

Creates a new file system loader with the given content parser.

Trait Implementations

impl<I> Default for FsLoader<I, Location<I, Span>, Value<Location<I, Span>>, Meta<Error<Location<I, Span>, Infallible>, Location<I, Span>>>where
    I: Clone,

fn default(
) -> FsLoader<I, Location<I, Span>, Value<Location<I, Span>>, Meta<Error<Location<I, Span>, Infallible>, Location<I, Span>>>

Returns the “default value” for a type.

impl<I, T, M, E> Loader<I, M> for FsLoader<I, M, T, E>where
    I: Send,
    T: Send,
    M: Send,

type Output = T

The type of documents that can be loaded.

type Error = Error<E>

Error type.

fn load_with<'a>(
    &'a mut self,
    vocabulary: &'a mut impl Sync + Send + IriVocabulary<Iri = I>,
    url: I
) -> Pin<Box<dyn Future<Output = Result<RemoteDocument<I, M, T>, <FsLoader<I, M, T, E> as Loader<I, M>>::Error>> + Send + 'a, Global>>where
    I: 'a,

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