Struct RemoteDocument 

pub struct RemoteDocument<I = IriBuf, T = Value> {
    pub url: Option<I>,
    pub content_type: Option<MediaTypeBuf>,
    pub context_url: Option<I>,
    pub profile: HashSet<Profile<I>>,
    pub document: T,
}

Remote document.

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

Fields

url: Option<I>

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

content_type: Option<MediaTypeBuf>

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

context_url: Option<I>

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<Profile<I>>

Profiles advertised by the document’s media type.

document: T

The retrieved document.

Implementations

impl<I, T> RemoteDocument<I, T>

pub fn new( url: Option<I>, content_type: Option<MediaTypeBuf>, 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<I>, content_type: Option<MediaTypeBuf>, context_url: Option<I>, profile: HashSet<Profile<I>>, 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) -> RemoteDocument<I, U>

Maps the content of the remote document.

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

Tries to map the content of the remote document.

Errors

Returns whatever f returns for the contained document.

pub fn map_iris<J>(self, f: impl FnMut(I) -> J) -> RemoteDocument<J, T>

where J: Eq + Hash,

Maps all the IRIs.

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

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

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

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

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

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<I>

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

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

Sets the URL of the document.

impl<I> RemoteDocument<I, Value>

pub fn from_value( url: Option<I>, content_type: Option<MediaTypeBuf>, document: impl Into<Value>, ) -> Self

Creates a remote document from any value convertible into a jstrict::Value.

With the serde_json feature enabled, this also accepts serde_json::Value thanks to the From<serde_json::Value> implementation provided by jstrict.

impl<I> RemoteDocument<I, Value>

pub fn from_serde_json( url: Option<I>, content_type: Option<MediaTypeBuf>, document: Value, ) -> Self

Available on crate feature serde-json only.

Creates a remote document from a serde_json::Value.

pub fn into_serde_json(self) -> RemoteDocument<I, Value>

Available on crate feature serde-json only.

Consumes the document, returning a RemoteDocument<I, serde_json::Value>.

impl<I> RemoteDocument<I, Value>

pub fn from_sonic_rs( url: Option<I>, content_type: Option<MediaTypeBuf>, document: &Value, ) -> Self

Available on crate feature sonic-rs only.

Creates a remote document from a sonic_rs::Value.

pub fn into_sonic_rs(self) -> RemoteDocument<I, Value>

Available on crate feature sonic-rs only.

Consumes the document, returning a RemoteDocument<I, sonic_rs::Value>.

Trait Implementations

impl<I, B> Borrow<RemoteDocument<I>> for Document<I, B>

fn borrow(&self) -> &RemoteDocument<I>

Immutably borrows from an owned value.

impl<I: Clone, T: Clone> Clone for RemoteDocument<I, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Debug, T: Debug> Debug for RemoteDocument<I, T>

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

Formats the value using the given formatter.