Struct Node 

pub struct Node<T = IriBuf, B = BlankIdBuf> {
    pub id: Option<Id<T, B>>,
    pub types: Option<Vec<Id<T, B>>>,
    pub graph: Option<Graph<T, B>>,
    pub included: Option<Included<T, B>>,
    pub properties: Properties<T, B>,
    pub reverse_properties: Option<ReverseProperties<T, B>>,
}

Node object.

A node object represents zero or more properties of a node in the graph serialized by a JSON-LD document. A node is defined by its identifier (@id field), types, properties and reverse properties. In addition, a node may represent a graph (@graph field) and include other nodes (@included field).

Fields

id: Option<Id<T, B>>

Identifier.

This is the @id field.

types: Option<Vec<Id<T, B>>>

Types.

This is the @type field.

graph: Option<Graph<T, B>>

Associated graph.

This is the @graph field.

included: Option<Included<T, B>>

Included nodes.

This is the @included field.

properties: Properties<T, B>

Properties.

Any non-keyword field.

reverse_properties: Option<ReverseProperties<T, B>>

Reverse properties.

This is the @reverse field.

Implementations

impl<T, B> Node<T, B>

pub fn new() -> Self

Creates a new empty node.

pub fn with_id(id: Id<T, B>) -> Self

Creates a new empty node with the given id.

pub fn new_graph(id: Id<T, B>, graph: Graph<T, B>) -> Self

Creates a new graph node.

pub fn reverse_properties_mut_or_default( &mut self, ) -> &mut ReverseProperties<T, B>

Returns a mutable reference to the reverse properties of the node.

If no @reverse entry is present, one is created.

pub fn included_mut_or_default(&mut self) -> &mut Included<T, B>

Returns a mutable reference to the included nodes.

If no @included entry is present, one is created.

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

where T: Eq + Hash, B: Eq + Hash,

Assigns an identifier to this node and every other node included in this one using the given generator.

Errors

Returns an error when the generator runs out of identifiers.

pub fn identify_all<G: LocalGenerator>( &mut self, generator: &mut G, ) -> Result<(), GeneratedIdError>

where T: Eq + Hash, B: Eq + Hash, (): Vocabulary<Iri = T, BlankId = B>,

Assigns an identifier to this node and every other node included in this one using the given generator.

Errors

Returns an error when the generator runs out of identifiers.

pub fn canonicalize_with(&mut self, buffer: &mut Buffer)

Puts every literal of the node into canonical form, using the given buffer to render numbers.

pub fn canonicalize(&mut self)

Puts every literal of the node into canonical form.

pub fn as_iri(&self) -> Option<&T>

Returns the node’s identifier as an IRI, if the node has one and it is an IRI.

pub fn as_str(&self) -> Option<&str>

where T: AsRef<str>,

Returns the node’s identifier as a string slice.

Returns None if the node has no @id field.

pub fn types(&self) -> &[Id<T, B>]

Returns the types of the node, or an empty slice if it has no @type entry.

pub fn types_mut(&mut self) -> &mut [Id<T, B>]

Mutably borrows the types of the node, or an empty slice if it has no @type entry.

pub fn types_mut_or_default(&mut self) -> &mut Vec<Id<T, B>>

Mutably borrows the types of this node, inserting an empty list if it has none.

pub fn types_mut_or_insert( &mut self, value: Vec<Id<T, B>>, ) -> &mut Vec<Id<T, B>>

Mutably borrows the types of this node, inserting value if it has none.

pub fn types_mut_or_insert_with( &mut self, f: impl FnOnce() -> Vec<Id<T, B>>, ) -> &mut Vec<Id<T, B>>

Mutably borrows the types of this node, inserting the result of f if it has none.

pub fn has_type<U>(&self, ty: &U) -> bool

where Id<T, B>: PartialEq<U>,

Checks if the node has the given type.

pub fn is_empty(&self) -> bool

Tests if the node is empty.

It is empty if every field other than @id is empty.

pub fn is_graph(&self) -> bool

Tests if the node is a graph object (has a @graph field, and optionally an @id field). A node object with a @graph entry is not considered a graph object if it includes any entry other than @id.

pub fn is_simple_graph(&self) -> bool

Tests if the node is a simple graph object (a graph object without @id field)

pub fn graph(&self) -> Option<&Graph<T, B>>

Returns the node objects of the @graph entry, if the node has one.

Note that having a @graph entry is necessary but not sufficient for the node to be a graph object; see is_graph.

pub fn graph_mut(&mut self) -> Option<&mut Graph<T, B>>

Mutably borrows the node objects of the @graph entry, if the node has one.

pub fn graph_entry(&self) -> Option<&Graph<T, B>>

Returns the node objects of the @graph entry, if the node has one.

Alias for graph.

pub fn graph_entry_mut(&mut self) -> Option<&mut Graph<T, B>>

Mutably borrows the node objects of the @graph entry, if the node has one.

Alias for graph_mut.

pub fn set_graph_entry(&mut self, graph: Option<Graph<T, B>>)

Sets the @graph entry of the node, or removes it when given None.

pub fn included_entry(&self) -> Option<&Included<T, B>>

Returns the set of nodes included by this node.

This corresponds to the @included field in the JSON representation.

pub fn included_entry_mut(&mut self) -> Option<&mut Included<T, B>>

Returns the mutable set of nodes included by this node.

This corresponds to the @included field in the JSON representation.

pub fn included(&self) -> Option<&Included<T, B>>

Returns a reference to the set of @included nodes.

pub fn included_mut(&mut self) -> Option<&mut Included<T, B>>

Returns a mutable reference to the set of @included nodes.

pub fn set_included(&mut self, included: Option<Included<T, B>>)

Sets the @included entry of the node, or removes it when given None.

pub fn properties(&self) -> &Properties<T, B>

Returns a reference to the properties of the node.

pub fn properties_mut(&mut self) -> &mut Properties<T, B>

Returns a mutable reference to the properties of the node.

pub fn reverse_properties(&self) -> Option<&ReverseProperties<T, B>>

Returns a reference to the reverse properties of the node, if it has a @reverse entry.

pub fn reverse_properties_entry(&self) -> Option<&ReverseProperties<T, B>>

Returns a reference to the reverse properties of the node, if it has a @reverse entry.

pub fn reverse_properties_mut(&mut self) -> Option<&mut ReverseProperties<T, B>>

Returns a mutable reference to the reverse properties of the node, if it has a @reverse entry.

pub fn set_reverse_properties( &mut self, reverse_properties: Option<ReverseProperties<T, B>>, )

Sets the reverse properties of this Node.

pub fn is_unnamed_graph(&self) -> bool

Tests if the node is an unnamed graph object.

Returns true if the only field of the object is a @graph field, false otherwise.

pub fn into_unnamed_graph(self: Box<Self>) -> Result<Graph<T, B>, Box<Self>>

Returns the node as an unnamed graph, if it is one.

The unnamed graph is returned as a set of indexed objects. Fails and returns itself if the node is not an unnamed graph.

Errors

Returns self unchanged when the object is not a graph object, or is a named graph.

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

Returns an iterator that visits every fragment of the node: the node itself and, recursively, everything it contains.

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

Counts the fragments of the node matching the given predicate.

pub fn entries(&self) -> Entries<'_, T, B>

Returns an iterator over the entries of the JSON representation of the node.

pub fn map_ids<U, C>( self, map_iri: impl FnMut(T) -> U, map_id: impl FnMut(Id<T, B>) -> Id<U, C>, ) -> Node<U, C>

where U: Eq + Hash, C: Eq + Hash,

Rewrites every IRI and identifier of the node (recursively) with the given functions.

impl<T: Eq + Hash, B: Eq + Hash> Node<T, B>

pub fn has_key(&self, key: &Term<T, B>) -> bool

Checks if the node object has the given term as key.

Example

// Checks if the JSON object representation of the node has an `@id` key.
if node.has_key(&Term::Keyword(Keyword::Id)) {
  // ...
}

pub fn get<'a, Q: ?Sized + Hash + Equivalent<Id<T, B>>>( &self, prop: &Q, ) -> Objects<'_, T, B>

where T: 'a,

Returns all the objects associated with the node through the given property.

pub fn get_any<'a, Q: ?Sized + Hash + Equivalent<Id<T, B>>>( &self, prop: &Q, ) -> Option<&IndexedObject<T, B>>

where T: 'a,

Returns one of the objects associated with the node through the given property.

If multiple objects are attached to the node with this property, there is no guarantee on which object is returned.

pub fn insert(&mut self, prop: Id<T, B>, value: IndexedObject<T, B>)

Associates the given object with the node through the given property.

pub fn insert_all<Objects: Iterator<Item = IndexedObject<T, B>>>( &mut self, prop: Id<T, B>, values: Objects, )

Associates all the given objects with the node through the given property.

If objects are already associated with the property, the new ones are appended to them. Duplicate objects are not removed.

pub fn reverse_properties_or_insert( &mut self, props: ReverseProperties<T, B>, ) -> &mut ReverseProperties<T, B>

Mutably borrows the reverse properties, inserting props if there are none.

pub fn reverse_properties_or_default(&mut self) -> &mut ReverseProperties<T, B>

Mutably borrows the reverse properties, inserting an empty set if there are none.

pub fn reverse_properties_or_insert_with( &mut self, f: impl FnOnce() -> ReverseProperties<T, B>, ) -> &mut ReverseProperties<T, B>

Mutably borrows the reverse properties, inserting the result of f if there are none.

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

Equivalence operator.

Equivalence differs from equality for anonymous objects: an anonymous node object stands for an implicit, unlabeled blank node, so it is never equivalent to anything.

Trait Implementations

impl<T, B> Any<T, B> for Node<T, B>

fn as_ref(&self) -> Ref<'_, T, B>

Borrows the object as a value, node or list reference.

fn id(&self) -> Option<&Id<T, B>>

Returns the identifier (@id) of the object, if it is a node object with one.

fn language<'a>(&'a self) -> Option<&'a LenientLangTag>

where T: 'a, B: 'a,

Returns the language tag of this value, if it carries one.

fn is_value(&self) -> bool

Checks whether the object is a value object.

fn is_node(&self) -> bool

Checks whether the object is a node object.

fn is_graph(&self) -> bool

Checks whether the object is a graph object (a node object with a @graph entry).

fn is_list(&self) -> bool

Checks whether the object is a list object.

impl<T: Clone, B: Clone> Clone for Node<T, B>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, B: Debug> Debug for Node<T, B>

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

Formats the value using the given formatter.

impl<T, B> Default for Node<T, B>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Eq + Hash, B: Eq + Hash> Eq for Node<T, B>

impl<T, B> From<Node<T, B>> for Object<T, B>

fn from(node: Node<T, B>) -> Self

Converts to this type from the input type.

impl<T: Hash, B: Hash> Hash for Node<T, B>

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, B, N: Vocabulary<Iri = T, BlankId = B>> IntoJsonWithContext<N> for Node<T, B>

fn into_json_with(self, vocabulary: &N) -> Value

Converts this value into JSON, resolving the identifiers it holds against the given vocabulary.

impl<T, B, I: Interpretation> LinkedData<I> for Node<T, B>

where T: LinkedDataResource<I> + LinkedDataSubject<I>, B: LinkedDataResource<I> + LinkedDataSubject<I>,

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

where S: Visitor<I>,

Visit the RDF dataset represented by this type.

impl<T, B, I: Interpretation> LinkedDataGraph<I> for Node<T, B>

where T: LinkedDataResource<I> + LinkedDataSubject<I>, B: LinkedDataResource<I> + LinkedDataSubject<I>,

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

where S: GraphVisitor<I>,

Visits the subjects of the graph represented by this value.

impl<T, B, I: Interpretation> LinkedDataPredicateObjects<I> for Node<T, B>

where T: LinkedDataResource<I> + LinkedDataSubject<I>, B: LinkedDataResource<I> + LinkedDataSubject<I>,

fn visit_objects<S>(&self, visitor: S) -> Result<S::Ok, S::Error>

where S: PredicateObjectsVisitor<I>,

Visits the objects this predicate points at.

impl<T, B, I: Interpretation> LinkedDataResource<I> for Node<T, B>

where T: LinkedDataResource<I>, B: LinkedDataResource<I>,

fn interpretation( &self, interpretation: &mut I, ) -> ResourceInterpretation<'_, I>

Returns the interpretation of this resource, inserting it into interpretation if required.

fn lexical_representation<'a>( &'a self, interpretation: &'a mut I, ) -> Option<CowRdfTerm<'a>>

where I: ReverseInterpretation + ReverseLocalInterpretation,

Returns the lexical term representing this resource, if any.

fn reference_interpretation( &self, interpretation: &mut I, ) -> ResourceInterpretation<'_, I>

Returns the interpretation to use when this resource appears as a reference rather than as a subject with properties.

impl<T, B, I: Interpretation> LinkedDataSubject<I> for Node<T, B>

where T: LinkedDataResource<I> + LinkedDataSubject<I>, B: LinkedDataResource<I> + LinkedDataSubject<I>,

fn visit_subject<S>(&self, visitor: S) -> Result<S::Ok, S::Error>

where S: SubjectVisitor<I>,

Visits the properties of the subject represented by this value.

impl<T: Eq + Hash, B: Eq + Hash> MappedEq for Node<T, B>

type BlankId = B

Blank node identifier type the renaming applies to.

fn mapped_eq<'a, 'b, F: Clone + Fn(&'a B) -> &'b B>( &'a self, other: &Self, f: F, ) -> bool

where B: 'a + 'b,

Structural equality with mapped blank identifiers.

impl<T: Eq + Hash, B: Eq + Hash> PartialEq for Node<T, B>

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

Equality operator ==.

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

Inequality operator !=.

impl<T, B, N: Vocabulary<Iri = T, BlankId = B>> PrecomputeSizeWithContext<N> for Node<T, B>

fn contextual_pre_compute_size( &self, vocabulary: &N, options: &Options, sizes: &mut Vec<Size>, ) -> Size

Computes the printed size of this value against context.

impl<T, B, N: Vocabulary<Iri = T, BlankId = B>> PrintWithContext<N> for Node<T, B>

fn contextual_fmt_with( &self, vocabulary: &N, f: &mut Formatter<'_>, options: &Options, indent: usize, ) -> Result

Writes the value to f, resolving it against context.

impl<T, B, N: Vocabulary<Iri = T, BlankId = B>> PrintWithSizeAndContext<N> for Node<T, B>

fn contextual_fmt_with_size( &self, vocabulary: &N, f: &mut Formatter<'_>, options: &Options, indent: usize, sizes: &[Size], index: &mut usize, ) -> Result

Writes the value to f against context, taking its layout from sizes[*index].

impl<T, B> Relabel<T, B> for Node<T, B>

fn relabel_with<N: VocabularyMut<Iri = T, BlankId = B>, G: LocalGenerator>( &mut self, vocabulary: &mut N, generator: &mut G, relabeling: &mut HashMap<B, ValidId<T, B>>, ) -> Result<(), GeneratedIdError>

where T: Clone + Eq + Hash, B: Clone + Eq + Hash,

Relabels every blank node, recording the mapping so shared nodes keep the same new identifier.

fn relabel<G: LocalGenerator>( &mut self, generator: &mut G, relabeling: &mut HashMap<B, ValidId<T, B>>, ) -> Result<(), GeneratedIdError>

where T: Clone + Eq + Hash, B: Clone + Eq + Hash, (): Vocabulary<Iri = T, BlankId = B>,

Relabels every blank node, recording the mapping.

impl<T, B> TryFrom<Object<T, B>> for Node<T, B>

type Error = Object<T, B>

The type returned in the event of a conversion error.

fn try_from(obj: Object<T, B>) -> Result<Node<T, B>, Object<T, B>>

Performs the conversion.

impl<T: Eq + Hash, B: Eq + Hash> TryFromJsonObject<T, B> for Node<T, B>

fn try_from_json_object_in( vocabulary: &mut impl VocabularyMut<Iri = T, BlankId = B>, object: Object, ) -> Result<Self, InvalidExpandedJson>

Builds this fragment from a JSON object, interning terms in the given vocabulary.