Struct Document 

pub struct Document<I = IriBuf, B = BlankIdBuf> { /* private fields */ }

JSON-LD document in both compact and expanded form.

Implementations

impl<I, B> Document<I, B>

pub fn new(remote: RemoteDocument<I>, expanded: ExpandedDocument<I, B>) -> Self

Creates a new Document.

pub fn into_remote(self) -> RemoteDocument<I>

Consumes the document, returning its remote (compact) form.

pub fn into_compact(self) -> Value

Consumes the document, returning its compact form as a JSON value.

pub fn into_expanded(self) -> ExpandedDocument<I, B>

Consumes the document, returning its expanded form.

pub fn into_parts(self) -> DocumentParts<I, B>

Consumes the document, returning its remote and expanded forms.

pub fn as_remote(&self) -> &RemoteDocument<I>

Returns the remote (compact) form of the document.

pub fn as_compact(&self) -> &Value

Returns the compact form of the document as a JSON value.

pub fn as_expanded(&self) -> &ExpandedDocument<I, B>

Returns the expanded form of the document.

Methods from Deref<Target = ExpandedDocument<I, B>>

pub fn len(&self) -> usize

Returns the number of top-level objects in the document.

pub fn is_empty(&self) -> bool

Checks whether the document has no top-level objects.

pub fn objects(&self) -> &[IndexedObject<T, B>]

Returns the top-level objects of the document, in insertion order.

pub fn iter(&self) -> Iter<'_, IndexedObject<T, B>>

Returns an iterator over the top-level objects of the document, in insertion order.

pub fn traverse(&self) -> Traverse<'_, T, B>

Returns an iterator that visits every fragment of the document: each top-level object and, recursively, everything it contains.

pub fn count(&self, f: impl FnMut(&FragmentRef<'_, T, B>) -> bool) -> usize

Counts the fragments of the document matching the given predicate.

pub fn blank_ids(&self) -> HashSet<&B>

where B: Eq + Hash,

Returns the set of all blank identifiers in the given document.

pub fn main_node(&self) -> Option<&Node<T, B>>

Returns the main node object of the document, if any.

The main node is the unique top level (root) node object. If multiple node objects are on the root, None is returned.

pub fn contains(&self, object: &IndexedObject<T, B>) -> bool

Checks whether an equal object is present.

pub fn generate_node_map_with<V: VocabularyMut<Iri = T, BlankId = B>, G: LocalGenerator>( &self, vocabulary: &mut V, generator: G, ) -> Result<NodeMap<T, B>, NodeMapError<T, B>>

Builds the node map of this document using the given vocabulary and blank node generator.

Errors

Returns an error when the generator runs out of identifiers, or when two nodes disagree on an @index.

Trait Implementations

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

fn borrow(&self) -> &ExpandedDocument<I, B>

Immutably borrows from an owned value.

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

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

Immutably borrows from an owned value.

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

fn borrow(&self) -> &Value

Immutably borrows from an owned value.

impl<I: Clone, B: Clone> Clone for Document<I, B>

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, B: Debug> Debug for Document<I, B>

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

Formats the value using the given formatter.

impl<I, B> Deref for Document<I, B>

type Target = ExpandedDocument<I, B>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<I: Eq + Hash, B: Eq + Hash> Eq for Document<I, B>

impl<I: Eq + Hash, B: Eq + Hash> PartialEq for Document<I, B>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<I, B> Serialize for Document<I, B>

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.