Struct JsonLdNode 

pub struct JsonLdNode {
    pub id: Option<JsonLdLenient<Id>>,
    pub types: Option<BTreeIndexMultiSet<JsonLdLenient<Id>>>,
    pub graph: Option<JsonLdGraph>,
    pub included: Option<JsonLdIncluded>,
    pub properties: JsonLdProperties,
    pub reverse_properties: Option<JsonLdReverseProperties>,
}

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 includes nodes (@included field).

Fields

id: Option<JsonLdLenient<Id>>

Identifier.

This is the @id field.

types: Option<BTreeIndexMultiSet<JsonLdLenient<Id>>>

Types.

This is the @type field.

graph: Option<JsonLdGraph>

Associated graph.

This is the @graph field.

included: Option<JsonLdIncluded>

Included nodes.

This is the @included field.

properties: JsonLdProperties

Properties.

Any non-keyword field.

reverse_properties: Option<JsonLdReverseProperties>

Reverse properties.

This is the @reverse field.

Implementations

impl JsonLdNode

pub fn new() -> Self

Creates a new empty node.

pub fn new_with_id(id: Option<JsonLdLenient<Id>>) -> Self

Creates a new empty node.

pub fn new_graph(id: JsonLdLenient<Id>, graph: JsonLdGraph) -> Self

Creates a new graph node.

pub fn reverse_properties_mut_or_default( &mut self, ) -> &mut JsonLdReverseProperties

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 JsonLdIncluded

Returns a mutable reference to the included nodes.

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

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

Get the node’s as an IRI if possible.

Returns the node’s IRI id if any. Returns None otherwise.

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

Get the node’s id, is any, as a string slice.

Returns None if the node has no @id field.

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

where U: ?Sized + Comparable<JsonLdLenient<Id>>,

Checks if the node has the given type.

pub fn is_empty(&self) -> bool

Tests if the node is empty.

It is empty is 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). Note that node objects may have a @graph entry, but are not considered graph objects if they include any other entries 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<&JsonLdGraph>

If the node is a graph object, get the graph.

pub fn graph_mut(&mut self) -> Option<&mut JsonLdGraph>

If the node is a graph object, get the mutable graph.

pub fn graph_entry(&self) -> Option<&JsonLdGraph>

If the node is a graph object, get the graph.

pub fn graph_entry_mut(&mut self) -> Option<&mut JsonLdGraph>

If the node is a graph object, get the mutable graph.

pub fn set_graph_entry(&mut self, graph: Option<JsonLdGraph>)

Set the graph.

pub fn included_entry(&self) -> Option<&JsonLdIncluded>

Get the set of nodes included by this node.

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

pub fn included_entry_mut(&mut self) -> Option<&mut JsonLdIncluded>

Get the mutable set of nodes included by this node.

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

pub fn included(&self) -> Option<&JsonLdIncluded>

Returns a reference to the set of @included nodes.

pub fn included_mut(&mut self) -> Option<&mut JsonLdIncluded>

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

pub fn set_included(&mut self, included: Option<JsonLdIncluded>)

Set the set of nodes included by the node.

pub fn properties(&self) -> &JsonLdProperties

Returns a reference to the properties of the node.

pub fn properties_mut(&mut self) -> &mut JsonLdProperties

Returns a mutable reference to the properties of the node.

pub fn reverse_properties(&self) -> Option<&JsonLdReverseProperties>

Returns a reference to the properties of the node.

pub fn reverse_properties_entry(&self) -> Option<&JsonLdReverseProperties>

Returns a reference to the reverse properties of the node.

pub fn reverse_properties_mut(&mut self) -> Option<&mut JsonLdReverseProperties>

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

pub fn set_reverse_properties( &mut self, reverse_properties: Option<JsonLdReverseProperties>, )

pub fn is_unnamed_graph(&self) -> bool

Tests if the node is an unnamed graph object.

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

pub fn into_unnamed_graph(self) -> Result<JsonLdGraph, 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.

pub fn entries(&self) -> JsonLdNodeEntries<'_>

pub fn has_key(&self, key: &JsonLdTerm) -> bool

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

Example

use json_ld::{JsonLdNode, JsonLdTerm};
use json_ld::syntax::JsonLdKeyword;

let node = JsonLdNode::new();

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

pub fn get<Q>(&self, prop: &Q) -> JsonLdObjects<'_>

where Q: ?Sized + Hash + Comparable<JsonLdLenient<Id>>,

Get all the objects associated to the node with the given property.

pub fn get_any<Q>(&self, prop: &Q) -> Option<&JsonLdIndexedObject>

where Q: ?Sized + Hash + Comparable<JsonLdLenient<Id>>,

Get one of the objects associated to the node with the given property.

If multiple objects are attached to the node with this property, there are no guaranties on which object will be returned.

pub fn insert(&mut self, prop: JsonLdLenient<Id>, value: JsonLdIndexedObject)

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

pub fn insert_all<Objects: IntoIterator<Item = JsonLdIndexedObject>>( &mut self, prop: JsonLdLenient<Id>, values: Objects, )

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

If there already exists objects associated to the given reverse property, reverse_value is added to the list. Duplicate objects are not removed.

pub fn reverse_properties_or_insert( &mut self, props: JsonLdReverseProperties, ) -> &mut JsonLdReverseProperties

pub fn reverse_properties_or_default(&mut self) -> &mut JsonLdReverseProperties

pub fn reverse_properties_or_insert_with( &mut self, f: impl FnOnce() -> JsonLdReverseProperties, ) -> &mut JsonLdReverseProperties

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

Equivalence operator.

Equivalence is different from equality for anonymous objects. Anonymous node objects have an implicit unlabeled blank nodes and thus never equivalent.

Trait Implementations

impl AnyJsonLdObject for JsonLdNode

fn as_ref(&self) -> JsonLdObjectRef<'_>

fn id(&self) -> Option<&JsonLdLenient<Id>>

fn language(&self) -> Option<JsonLdLenient<&LangTag>>

fn is_value(&self) -> bool

fn is_node(&self) -> bool

fn is_graph(&self) -> bool

fn is_list(&self) -> bool

impl Clone for JsonLdNode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonLdNode

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

Formats the value using the given formatter.

impl Default for JsonLdNode

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JsonLdNode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for JsonLdNode

impl From<JsonLdNode> for JsonLdObject

fn from(node: JsonLdNode) -> Self

Converts to this type from the input type.

impl Hash for JsonLdNode

fn hash<__H: Hasher>(&self, state: &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 JsonLdVisit for JsonLdNode

fn visit_with(&self, f: &mut impl FnMut(JsonLdObjectRef<'_>))

fn visit_mut_with(&mut self, f: &mut impl FnMut(JsonLdObjectMut<'_>))

fn visit(&self, f: impl FnMut(JsonLdObjectRef<'_>))

fn visit_mut(&mut self, f: impl FnMut(JsonLdObjectMut<'_>))

fn relabel_with(&mut self, relabeling: &mut JsonLdRelabeling<impl Generator>)

fn relabel<G: Generator>(&mut self, generator: G) -> JsonLdRelabeling<G>

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

fn canonicalize(&mut self)

fn relabel_and_canonicalize_with( &mut self, relabeling: &mut JsonLdRelabeling<impl Generator>, buffer: &mut Buffer, )

fn relabel_and_canonicalize<G: Generator>( &mut self, generator: G, ) -> JsonLdRelabeling<G>

impl Ord for JsonLdNode

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for JsonLdNode

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for JsonLdNode

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for JsonLdNode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SerializeLinkedData for JsonLdNode

fn serialize_rdf<S>( &self, serializer: S, graph: Option<&Term>, ) -> Result<S::Ok, S::Error>

where S: LinkedDataSerializer<Term>,

fn serialize_rdf_subjects<S>( &self, serializer: S, predicate: &R, object: &R, graph: Option<&R>, ) -> Result<<S as LinkedDataSerializer<R>>::Ok, <S as LinkedDataSerializer<R>>::Error>

where S: LinkedDataSerializer<R>,

fn serialize_rdf_objects<S>( &self, serializer: S, subject: &R, predicate: &R, graph: Option<&R>, ) -> Result<<S as LinkedDataSerializer<R>>::Ok, <S as LinkedDataSerializer<R>>::Error>

where S: LinkedDataSerializer<R>,

fn serialize_rdf_graph<S>( &self, serializer: S, graph: Option<&R>, ) -> Result<<S as LinkedDataSerializer<R>>::Ok, <S as LinkedDataSerializer<R>>::Error>

where S: LinkedDataSerializer<R>,

Serialize quads, ignoring top level resources.

impl SerializeLinkedDataWith<RdfSerializationOptions> for JsonLdNode

fn serialize_rdf_with<S>( &self, opts: RdfSerializationOptions, serializer: S, graph: Option<&Term>, ) -> Result<S::Ok, S::Error>

where S: LinkedDataSerializer<Term>,

fn serialize_rdf_subjects_with<S>( &self, state: Q, serializer: S, predicate: &R, object: &R, graph: Option<&R>, ) -> Result<<S as LinkedDataSerializer<R>>::Ok, <S as LinkedDataSerializer<R>>::Error>

where S: LinkedDataSerializer<R>,

fn serialize_rdf_objects_with<S>( &self, state: Q, serializer: S, subject: &R, predicate: &R, graph: Option<&R>, ) -> Result<<S as LinkedDataSerializer<R>>::Ok, <S as LinkedDataSerializer<R>>::Error>

where S: LinkedDataSerializer<R>,

fn serialize_rdf_graph_with<S>( &self, state: Q, serializer: S, graph: Option<&R>, ) -> Result<<S as LinkedDataSerializer<R>>::Ok, <S as LinkedDataSerializer<R>>::Error>

where S: LinkedDataSerializer<R>,

Serialize quads, ignoring top level resources.

impl StructuralPartialEq for JsonLdNode

impl TryFrom<JsonLdObject> for JsonLdNode

type Error = JsonLdObject

The type returned in the event of a conversion error.

fn try_from(obj: JsonLdObject) -> Result<JsonLdNode, JsonLdObject>

Performs the conversion.