Struct json_ld::object::node::Node

pub struct Node<T: Id = IriBuf> { /* fields omitted */ }

A node object.

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

Methods

impl<T: Id> Node<T>

pub fn new() -> Node<T>

Create a new empty node.

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<&Lenient<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) -> &[Lenient<Reference<T>>]

Get the list of the node's types.

This returns a list of Lenient types, including malformed types that are not IRIs of blank node identifiers.

pub fn has_type<U>(&self, ty: &U) -> bool where
    Lenient<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 except for @id is empty.

pub fn is_graph(&self) -> bool

Tests if the node is a graph object (has a @graph field).

pub fn graph(&self) -> Option<&HashSet<Indexed<Object<T>>>>

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

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

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

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

Set the graph.

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

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<Node<T>>>>

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<Node<T>>>>)

Set the set of nodes included by the node.

pub fn get<'a, Q: ToReference<T>>(&self, prop: Q) -> Objects<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<T>>> where
    T: 'a, 

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

If multiple objects are attaced 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<T>>)

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

pub fn insert_all<Objects: Iterator<Item = Indexed<Object<T>>>>(
    &mut self,
    prop: Reference<T>,
    values: Objects
)

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

pub fn insert_reverse(
    &mut self,
    reverse_prop: Reference<T>,
    reverse_value: Indexed<Node<T>>
)

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

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<T>>>, Node<T>>

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<T: Id> AsJson for Node<T>

fn as_json(&self) -> JsonValue

impl<T: Eq + Id> Eq for Node<T>

impl<T: Id> From<Node<T>> for Object<T>

fn from(node: Node<T>) -> Object<T>

Performs the conversion.

impl<T: Id> Hash for Node<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<T: PartialEq + Id> PartialEq<Node<T>> for Node<T>

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

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

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

This method tests for !=.

impl<T: Id> StructuralEq for Node<T>

impl<T: Id> StructuralPartialEq for Node<T>

impl<T: Id> TryFrom<Object<T>> for Node<T>

type Error = Object<T>

The type returned in the event of a conversion error.

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

Performs the conversion.