Enum json_ld::Object

source ·

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

Expand description

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

Node object.

§

List(List<T, B, M>)

List object.

Implementations§

source §

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

source

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

Creates a new node object from a node.

source

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

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

source

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.

source

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.

source

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.

source

pub fn canonicalize(&mut self)

Puts this object literals into canonical form.

source

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

Returns an iterator over the types of the object.

source

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.

source

pub fn is_value(&self) -> bool

Tests if the object is a value.

source

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

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

source

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

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

source

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

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

source

pub fn is_node(&self) -> bool

Tests if the object is a node.

source

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

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

source

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

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

source

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

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

source

pub fn is_graph(&self) -> bool

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

source

pub fn is_list(&self) -> bool

Tests if the object is a list.

source

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

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

source

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

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

source

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

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

source

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.

source

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

Get the value as a boolean, if it is.

source

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

Get the value as a number, if it is.

source

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

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

source

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

source

pub fn equivalent(&self, other: &Object<T, B, M>) -> bool
where 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.

source