Struct json_ld::object::node::Node

pub struct Node<J: JsonHash, T: Id = IriBuf> { /* private fields */ }

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).

Implementations

impl<J: JsonHash, T: Id> Node<J, T>

pub fn new() -> Self

Creates a new empty node.

pub fn with_id(id: Reference<T>) -> Self

Creates a new empty node with the given id.

pub fn has_key(&self, key: &Term<T>) -> 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 id(&self) -> Option<&Reference<T>>

Get the identifier of the node.

This correspond to the @id field of the JSON object.

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 types(&self) -> &[Reference<T>]

Get the list of the node’s types.

pub fn has_type<U>(&self, ty: &U) -> bool where
    Reference<T>: 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 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<&HashSet<Indexed<Object<J, T>>>>

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

pub fn graph_mut(&mut self) -> Option<&mut HashSet<Indexed<Object<J, T>>>>

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

pub fn set_graph(&mut self, graph: Option<HashSet<Indexed<Object<J, T>>>>)

Set the graph.

pub fn included(&self) -> Option<&HashSet<Indexed<Self>>>

Get the set of nodes included by this node.

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

pub fn included_mut(&mut self) -> Option<&mut HashSet<Indexed<Self>>>

Get the mutable set of nodes included by this node.

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

pub fn set_included(&mut self, included: Option<HashSet<Indexed<Self>>>)

Set the set of nodes included by the node.

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

Returns a reference to the properties of the node.

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

Returns a reference to the reverse properties of the node.

pub fn get<'a, Q: ToReference<T>>(&self, prop: Q) -> Objects<'_, J, T> where
    T: 'a, 

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

pub fn get_any<'a, Q: ToReference<T>>(
    &self,
    prop: Q
) -> Option<&Indexed<Object<J, T>>> where
    T: 'a, 

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: Reference<T>, value: Indexed<Object<J, T>>)

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

pub fn insert_all<Objects: Iterator<Item = Indexed<Object<J, T>>>>(
    &mut self,
    prop: Reference<T>,
    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 insert_reverse(
    &mut self,
    reverse_prop: Reference<T>,
    reverse_value: Indexed<Self>
)

Associates the given node to the reverse property.

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

pub fn insert_all_reverse<Nodes: Iterator<Item = Indexed<Self>>>(
    &mut self,
    reverse_prop: Reference<T>,
    reverse_values: Nodes
)

Associates all the given nodes to the reverse property.

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<HashSet<Indexed<Object<J, T>>>, 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.

Trait Implementations

impl<J: JsonHash, T: Id> Any<J, T> for Node<J, T>

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

fn id<'a>(&'a self) -> Option<&Reference<T>> where
    J: 'a, 

fn language<'a>(&'a self) -> Option<LenientLanguageTag<'_>> where
    J: 'a,
    T: 'a, 

fn is_value(&self) -> bool

fn is_node(&self) -> bool

fn is_graph(&self) -> bool

fn is_list(&self) -> bool

impl<J: JsonHash + JsonClone, K: JsonFrom<J>, T: Id> AsJson<J, K> for Node<J, T>

fn as_json_with(
    &self,
    meta: impl Clone + Fn(Option<&J::MetaData>) -> K::MetaData
) -> K

Converts this value into a K JSON value using the given meta function to convert J::MetaData into K::MetaData.

fn as_json(&self) -> K where
    K::MetaData: Default, 

Converts this value into a K JSON value.

impl<J: JsonHash, T: Id> Default for Node<J, T>

fn default() -> Self

Returns the “default value” for a type.

impl<J: JsonHash, T: Id> From<Node<J, T>> for Object<J, T>

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

Performs the conversion.

impl<J: JsonHash, T: Id> Hash for Node<J, T>

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, 

Feeds a slice of this type into the given Hasher.

impl<J: PartialEq + JsonHash, T: PartialEq + Id> PartialEq<Node<J, T>> for Node<J, T>

fn eq(&self, other: &Node<J, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Node<J, T>) -> bool

This method tests for !=.

impl<J: JsonHash, T: Id> TryFrom<Object<J, T>> for Node<J, T>

type Error = Object<J, T>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<J: Eq + JsonHash, T: Eq + Id> Eq for Node<J, T>

impl<J: JsonHash, T: Id> StructuralEq for Node<J, T>

impl<J: JsonHash, T: Id> StructuralPartialEq for Node<J, T>