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>, ) -> Document<I, B>

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

pub fn into_compact(self) -> Value

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

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

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

pub fn as_compact(&self) -> &Value

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

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

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn objects(&self) -> &IndexSet<Indexed<Object<T, B>>>

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

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

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

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 generate_node_map_with<V, G>( &self, vocabulary: &mut V, generator: G, ) -> Result<NodeMap<T, B>, ConflictingIndexes<T, B>>

where V: Vocabulary<Iri = T, BlankId = B>, G: Generator<V>,

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

where I: Clone, B: Clone,

fn clone(&self) -> Document<I, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

where I: Debug, B: Debug,

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

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) -> &<Document<I, B> as Deref>::Target

Dereferences the value.

impl<V, I> LinkedData<I, V> for Document<<V as IriVocabulary>::Iri, <V as BlankIdVocabulary>::BlankId>

where V: Vocabulary + IriVocabularyMut, I: Interpretation, <V as IriVocabulary>::Iri: LinkedDataSubject<I, V> + LinkedDataResource<I, V>, <V as BlankIdVocabulary>::BlankId: LinkedDataSubject<I, V> + LinkedDataResource<I, V>,

fn visit<S>( &self, visitor: S, ) -> Result<<S as Visitor<I, V>>::Ok, <S as Visitor<I, V>>::Error>

where S: Visitor<I, V>,

Visit the RDF dataset represented by this type.

impl<V, I> LinkedDataGraph<I, V> for Document<<V as IriVocabulary>::Iri, <V as BlankIdVocabulary>::BlankId>

where V: Vocabulary + IriVocabularyMut, I: Interpretation, <V as IriVocabulary>::Iri: LinkedDataSubject<I, V> + LinkedDataResource<I, V>, <V as BlankIdVocabulary>::BlankId: LinkedDataSubject<I, V> + LinkedDataResource<I, V>,

fn visit_graph<S>( &self, visitor: S, ) -> Result<<S as GraphVisitor<I, V>>::Ok, <S as GraphVisitor<I, V>>::Error>

where S: GraphVisitor<I, V>,

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

where I: Eq + Hash, B: Eq + Hash,

fn eq(&self, other: &Document<I, B>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

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

where I: Eq + Hash, B: Eq + Hash,