Struct json_ld::object::node::properties::Properties

pub struct Properties<J: JsonHash, T: Id>(_);

Properties of a node object, and their associated objects.

Example

use json_ld::{context, Document, NoLoader};
use serde_json::Value;
let doc: Value = serde_json::from_str(
  r#"
  {
     "@context": {
       "name": "http://xmlns.com/foaf/0.1/name"
     },
     "@id": "https://www.rust-lang.org",
     "name": "Rust Programming Language"
   }
"#,
)
.unwrap();

let mut loader = NoLoader::<Value>::new();

let rt  = tokio::runtime::Runtime::new().unwrap();
let expanded_doc = rt.block_on(doc
  .expand::<context::Json<Value>, _>(&mut loader)).unwrap();

let node = expanded_doc.into_iter().next().unwrap().into_indexed_node().unwrap();

for (property, objects) in node.properties() {
  assert_eq!(property, "http://xmlns.com/foaf/0.1/name");
  for object in objects {
    // do something
  }
}

Implementations

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

pub fn len(&self) -> usize

Returns the number of properties.

pub fn is_empty(&self) -> bool

Checks if there are no defined properties.

pub fn contains<Q: ToReference<T>>(&self, prop: Q) -> bool

Checks if the given property is associated to any object.

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

Returns an iterator over all the objects associated to 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 given property.

If multiple objects are found, there are no guaranties on which object will be returned.

pub fn insert(&mut self, prop: Reference<T>, value: Indexed<Object<J, T>>)

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

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

pub fn iter(&self) -> Iter<'_, J, T>

Returns an iterator over the properties and their associated objects.

pub fn iter_mut(&mut self) -> IterMut<'_, J, T>

Returns an iterator over the properties with a mutable reference to their associated objects.

Trait Implementations

impl<J: JsonHash, T: Id> Hash for Properties<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<'a, J: JsonHash, T: Id> IntoIterator for &'a Properties<J, T>

type Item = BindingRef<'a, J, T>

The type of the elements being iterated over.

type IntoIter = Iter<'a, J, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, J: JsonHash, T: Id> IntoIterator for &'a mut Properties<J, T>

type Item = BindingMut<'a, J, T>

The type of the elements being iterated over.

type IntoIter = IterMut<'a, J, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

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

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

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

This method tests for !=.

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

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

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