Enum json_ld::Object

pub enum Object<T = IriBuf, B = BlankIdBuf, M = ()> {
    Value(Value<T, M>),
    Node(Box<Node<T, B, M>, Global>),
    List(List<T, B, M>),
}

Object.

JSON-LD connects together multiple kinds of data objects. Objects may be nodes, values or lists of objects.

You can get an Object by expanding a JSON-LD document using the expansion algorithm or by converting an already expanded JSON document using TryFromJson.

Variants

Value(Value<T, M>)

Value object.

Node(Box<Node<T, B, M>, Global>)

Node object.

List(List<T, B, M>)

List object.

Implementations

impl<T, B, M> Object<T, B, M>

pub fn node(n: Node<T, B, M>) -> Object<T, B, M>

Creates a new node object from a node.

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

Identifier of the object, if it is a node object.

pub fn identify_all_with<V, G>(&mut self, vocabulary: &mut V, generator: &mut G)where
    V: Vocabulary<Iri = T, BlankId = B>,
    G: MetaGenerator<V, M>,
    M: Clone,
    T: Eq + Hash,
    B: Eq + Hash,

Assigns an identifier to every node included in this object using the given generator.

pub fn identify_all<G>(&mut self, generator: &mut G)where
    G: MetaGenerator<(), M>,
    M: Clone,
    T: Eq + Hash,
    B: Eq + Hash,
    (): Vocabulary<Iri = T, BlankId = B>,

Use the given generator to assign an identifier to all nodes that don’t have one.

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

Puts this object literals into canonical form using the given buffer.

The buffer is used to compute the canonical form of numbers.

pub fn canonicalize(&mut self)

Puts this object literals into canonical form.

pub fn types(&self) -> Types<'_, T, B, M>

Returns an iterator over the types of the object.

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

Identifier of the object as an IRI.

If the object is a node identified by an IRI, returns this IRI. Returns None otherwise.

pub fn is_value(&self) -> bool

Tests if the object is a value.

pub fn as_value(&self) -> Option<&Value<T, M>>

Returns this object as a value, if it is one.

pub fn into_value(self) -> Option<Value<T, M>>

Converts this object as a value, if it is one.

pub fn is_node(&self) -> bool

Tests if the object is a node.

pub fn as_node(&self) -> Option<&Node<T, B, M>>

Returns this object as a node, if it is one.

pub fn into_node(self) -> Option<Node<T, B, M>>

Converts this object into a node, if it is one.

pub fn is_graph(&self) -> bool

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

pub fn is_list(&self) -> bool

Tests if the object is a list.

pub fn as_list(&self) -> Option<&List<T, B, M>>

Returns this object as a list, if it is one.

pub fn into_list(self) -> Option<List<T, B, M>>

Converts this object into a list, if it is one.

pub fn as_str(&self) -> Option<&str>where
    T: AsRef<str>,
    B: AsRef<str>,

Get the object as a string.

If the object is a value that is a string, returns this string. If the object is a node that is identified, returns the identifier as a string. Returns None otherwise.

pub fn as_bool(&self) -> Option<bool>

Get the value as a boolean, if it is.

pub fn as_number(&self) -> Option<&Number>

Get the value as a number, if it is.

pub fn language(&self) -> Option<LenientLanguageTag<'_>>

If the object is a language-tagged value, Return its associated language.

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

Returns an iterator over all fragments of this object, including the object itself.

Fragments include:

• objects
• key-value pairs,
• keys
• values

pub fn equivalent(&self, other: &Object<T, B, M>) -> boolwhere
    T: Eq + Hash,
    B: Eq + Hash,

Equivalence operator.

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

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

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

Trait Implementations

impl<T, B, M> Any<T, B, M> for Object<T, B, M>

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

fn id_entry<'a>(&'a self) -> Option<&'a Entry<Id<T, B>, M>>where
    M: 'a,

fn id<'a>(&'a self) -> Option<&'a Meta<Id<T, B>, M>>where
    M: 'a,

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

fn is_value(&self) -> bool

fn is_node(&self) -> bool

fn is_graph(&self) -> bool

fn is_list(&self) -> bool

impl<T, B, M> Clone for Object<T, B, M>where
    T: Clone,
    B: Clone,
    M: Clone,

fn clone(&self) -> Object<T, B, M>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Converts to this type from the input type.

impl<T, B, M> From<Value<T, M>> for Object<T, B, M>

fn from(value: Value<T, M>) -> Object<T, B, M>

Converts to this type from the input type.

impl<T, B, M> Hash for Object<T, B, M>where
    T: Hash,
    B: Hash,
    M: Hash,

fn hash<__H>(&self, state: &mut __H)where
    __H: Hasher,

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, M, N> IntoJsonWithContextMeta<M, N> for Object<T, B, M>where
    M: Clone,
    N: Vocabulary<Iri = T, BlankId = B>,

fn into_json_meta_with(self, meta: M, vocabulary: &N) -> Meta<Value<M>, M>

impl<T, B, M> MappedEq<Object<T, B, M>> for Object<T, B, M>where
    T: Eq + Hash,
    B: Eq + Hash,

type BlankId = B

fn mapped_eq<'a, 'b, F>(&'a self, other: &Object<T, B, M>, f: F) -> boolwhere
    F: Clone + Fn(&'a B) -> &'b B,
    B: 'a + 'b,

Structural equality with mapped blank identifiers.

impl<T, B, M> PartialEq<Object<T, B, M>> for Object<T, B, M>where
    T: Eq + Hash,
    B: Eq + Hash,
    M: PartialEq<M>,

fn eq(&self, other: &Object<T, B, M>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, B, M> Relabel<T, B, M> for Object<T, B, M>

fn relabel_with<N, G>(
    &mut self,
    vocabulary: &mut N,
    generator: &mut G,
    relabeling: &mut HashMap<B, Meta<Subject<T, B>, M>, BuildHasherDefault<AHasher>, Global>
)where
    N: Vocabulary<Iri = T, BlankId = B>,
    G: MetaGenerator<N, M>,
    M: Clone,
    T: Clone + Eq + Hash,
    B: Clone + Eq + Hash,

impl<T, B, M> StrippedHash for Object<T, B, M>where
    T: Hash,
    B: Hash,

fn stripped_hash<H>(&self, state: &mut H)where
    H: Hasher,

impl<T, B, M> StrippedPartialEq<Object<T, B, M>> for Object<T, B, M>where
    T: Eq + Hash,
    B: Eq + Hash,

fn stripped_eq(&self, other: &Object<T, B, M>) -> bool

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

type Error = Object<T, B, M>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, B, M> TryFromJson<T, B, M> for Object<T, B, M>where
    T: Eq + Hash,
    B: Eq + Hash,

fn try_from_json_in(
    vocabulary: &mut impl VocabularyMut<Iri = T, BlankId = B>,
    _: Meta<Value<M>, M>
) -> Result<Meta<Object<T, B, M>, M>, Meta<InvalidExpandedJson<M>, M>>

impl<T, B, M> TryFromJsonObject<T, B, M> for Object<T, B, M>where
    T: Eq + Hash,
    B: Eq + Hash,

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

impl<T, B, M> Eq for Object<T, B, M>where
    T: Eq + Hash,
    B: Eq + Hash,
    M: Eq,

impl<T, B, M> StrippedEq for Object<T, B, M>where
    T: Eq + Hash,
    B: Eq + Hash,